OpenAPI 3.1 Webhooks Section (YAML)
Minimal OpenAPI 3.1 document with a webhooks section — for testing webhook-aware spec parsers.
openapi: 3.1.0
info:
title: Webhook Callback SAMPLE
version: 1.0.0
paths: {}
webhooks:
orderCreated:
post:
requestBody:
content:
application/json:
schema:
type: object
required: [order_id, status]
properties:
order_id: {type: string}
status: {type: string}
responses:
'200':
description: Acknowledged
Specifications
- Format
- OpenAPI 3.1
- Webhooks
- 1
Testing contract
Expected to pass- Scenario
- Exercise OpenAPI 3.1 Webhooks Section (YAML) in its schema workflow. Minimal OpenAPI 3.1 document with a webhooks section — for testing webhook-aware spec parsers.
- Expected result
- 20 text lines, decoded as UTF-8; first nonempty line is 'openapi: 3.1.0'. Declared feature checks: webhooks=1.
What is a .yaml file?
YAML (YAML Ain't Markup Language) is a human-readable data-serialization format using indentation, key-value pairs, and lists, and is a superset of JSON. It supports comments, anchors, and multiple documents per file, favoring readability for configuration. Its indentation sensitivity makes it error-prone to hand-edit.
How to use this file
Use an example YAML file to test config parsers, indentation and anchor handling, multi-document streams, and safe-loading to avoid arbitrary object construction.
How to use this file for testing
“OpenAPI 3.1 Webhooks Section (YAML)” is a deterministic Novus Examples fixture for Schema / OpenAPI testing, API testing. Valid and intentionally invalid OpenAPI/JSON Schema documents plus request/response examples for schema validators and API tooling.
Documented properties for this file: OpenAPI 3.1. Compare results against paired or grouped companions on this page when present (clean↔damaged, searchable↔scanned, or format twins) so scores stay reproducible across runs.
Download the file once, keep the path stable in CI or local scripts, and treat the spec table as the contract: dimensions, seeds, field lists, and roles are intentional. Corrupt or invalid samples are labelled as such, expect parsers to fail loudly rather than silently accept them.
Data fixtures document their exact quirks (delimiters, encodings, null handling, schema, and row counts) in the spec table. Point your parser or importer at the file and assert it handles the documented edge cases; clean and deliberately-messy siblings make before/after diffs straightforward.
Valid and intentionally invalid siblings are labelled in title and description. Assert parsers accept the valid twin and fail loudly on the invalid one; for time series, check DST gaps and duplicate keys against the spec table.
Code examples
import yaml # pip install pyyaml
with open("webhook-callback-openapi.yaml") as f:
data = yaml.safe_load(f)
print(data)Related files
- jsonAvro Schema Evolution - Backward-CompatibleThe compatible Avro record schema for reader/writer compatibility tests. Backward compatible for old records: nullable email is added with a null default.
- jsonAvro Schema Evolution - BaselineThe baseline Avro record schema for reader/writer compatibility tests. Reference writer schema: id and name are strings.
- jsonAvro Schema Evolution - BreakingThe breaking Avro record schema for reader/writer compatibility tests. Breaking relative to baseline: id changes to long and tenantId has no default.
- jsonJSON Schema Schema Evolution - Backward-CompatibleThe compatible member of a JSON Schema 2020-12 customer contract. Backward compatible: existing instances remain valid because email is optional.
- jsonJSON Schema Schema Evolution - BaselineThe baseline member of a JSON Schema 2020-12 customer contract. Reference contract: id and name are required strings.
- jsonJSON Schema Schema Evolution - BreakingThe breaking member of a JSON Schema 2020-12 customer contract. Breaking relative to baseline: id changes from string to integer and tenantId becomes required.
Generated by generation/data_wave_f.py. Free for any use, no attribution required, license.