add description to all schemas
in v3.1 the number of schemas increased considerably, which can be a bit confusing.
MODIFY
schemas/v3.0/schema.json
schemas/v3.0/schema.json
{
"id": "https://spec.openapis.org/oas/3.0/schema/2021-09-28",
"$schema": "http://json-schema.org/draft-04/schema#",
- "description": "Validation schema for OpenAPI Specification 3.0.X.",
+ "description": "The description of OpenAPI v3.0.x documents, as defined by https://spec.openapis.org/oas/v3.0.3",
"type": "object",
"required": [
"openapi",

MODIFY
schemas/v3.0/schema.yaml
schemas/v3.0/schema.yaml
id: https://spec.openapis.org/oas/3.0/schema/2021-09-28
$schema: http://json-schema.org/draft-04/schema#
-description: Validation schema for OpenAPI Specification 3.0.X.
+description: The description of OpenAPI v3.0.x documents, as defined by https://spec.openapis.org/oas/v3.0.3
type: object
required:
- openapi

MODIFY
schemas/v3.1/dialect/base.schema.json
schemas/v3.1/dialect/base.schema.json
{
+ "title": "OpenAPI 3.1 Schema Object Dialect",
+ "description": "A JSON Schema dialect describing schemas found in OpenAPI documents",
"$id": "https://spec.openapis.org/oas/3.1/dialect/base",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$vocabulary": {
},
"$dynamicAnchor": "meta",
- "title": "OpenAPI 3.1 Schema Object Dialect",
"allOf": [
{ "$ref": "https://json-schema.org/draft/2020-12/schema" },
{ "$ref": "https://spec.openapis.org/oas/3.1/meta/base" }

MODIFY
schemas/v3.1/dialect/base.schema.yaml
schemas/v3.1/dialect/base.schema.yaml
---
+title: OpenAPI 3.1 Schema Object Dialect
+description: A JSON Schema dialect describing schemas found in OpenAPI documents
$dynamicAnchor: meta
$id: https://spec.openapis.org/oas/3.1/dialect/base
$schema: https://json-schema.org/draft/2020-12/schema
@@ -14,4 +16,3 @@ $vocabulary:
allOf:
- $ref: https://json-schema.org/draft/2020-12/schema
- $ref: https://spec.openapis.org/oas/3.1/meta/base
-title: OpenAPI 3.1 Schema Object Dialect

MODIFY
schemas/v3.1/meta/base.schema.json
schemas/v3.1/meta/base.schema.json
{
+ "title": "OAS Base vocabulary",
+ "description": "A JSON Schema Vocabulary used in the OpenAPI Schema Dialect",
"$id": "https://spec.openapis.org/oas/3.1/meta/base",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$vocabulary": {
"https://spec.openapis.org/oas/3.1/vocab/base": true
},
"$dynamicAnchor": "meta",
- "title": "OAS Base vocabulary",
"type": ["object", "boolean"],
"properties": {

MODIFY
schemas/v3.1/meta/base.schema.yaml
schemas/v3.1/meta/base.schema.yaml
---
+title: OAS Base vocabulary
+description: A JSON Schema Vocabulary used in the OpenAPI Schema Dialect
$defs:
discriminator:
$ref: '#/$defs/extensible'
@@ -57,7 +59,6 @@ properties:
$ref: '#/$defs/external-docs'
xml:
$ref: '#/$defs/xml'
-title: OAS Base vocabulary
type:
- object
- boolean

MODIFY
schemas/v3.1/schema-base.json
schemas/v3.1/schema-base.json
{
+ "description": "The description of OpenAPI v3.1.x documents using the OpenAPI JSON Schema dialect, as defined by https://spec.openapis.org/oas/v3.1.0",
"$id": "https://spec.openapis.org/oas/3.1/schema-base/2021-09-28",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$ref": "https://spec.openapis.org/oas/3.1/schema/2021-09-28",

MODIFY
schemas/v3.1/schema-base.yaml
schemas/v3.1/schema-base.yaml
+description: The description of OpenAPI v3.1.x documents using the OpenAPI JSON Schema dialect, as defined by https://spec.openapis.org/oas/v3.1.0
$id: 'https://spec.openapis.org/oas/3.1/schema-base/2021-09-28'
$schema: 'https://json-schema.org/draft/2020-12/schema'

MODIFY
schemas/v3.1/schema.json
schemas/v3.1/schema.json
{
+ "description": "The description of OpenAPI v3.1.x documents without schema validation, as defined by https://spec.openapis.org/oas/v3.1.0",
"$id": "https://spec.openapis.org/oas/3.1/schema/2021-09-28",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",

MODIFY
schemas/v3.1/schema.yaml
schemas/v3.1/schema.yaml
+description: The description of OpenAPI v3.1.x documents without schema validation, as defined by https://spec.openapis.org/oas/v3.1.0
$id: 'https://spec.openapis.org/oas/3.1/schema/2021-09-28'
$schema: 'https://json-schema.org/draft/2020-12/schema'

add description to all schemas (#2802)

in v3.1 the number of schemas increased considerably, which can be a bit confusing.