From 12bc151e7352080f9767f3b055fb1b5ac0fa2f73 Mon Sep 17 00:00:00 2001 From: Karen Etheridge Date: Sun, 31 Oct 2021 13:31:48 -0700 Subject: [PATCH] add description to all schemas in v3.1 the number of schemas increased considerably, which can be a bit confusing. --- schemas/v3.0/schema.json | 2 +- schemas/v3.0/schema.yaml | 2 +- schemas/v3.1/dialect/base.schema.json | 3 ++- schemas/v3.1/dialect/base.schema.yaml | 3 ++- schemas/v3.1/meta/base.schema.json | 3 ++- schemas/v3.1/meta/base.schema.yaml | 3 ++- schemas/v3.1/schema-base.json | 1 + schemas/v3.1/schema-base.yaml | 1 + schemas/v3.1/schema.json | 1 + schemas/v3.1/schema.yaml | 1 + 10 files changed, 14 insertions(+), 6 deletions(-) diff --git a/schemas/v3.0/schema.json b/schemas/v3.0/schema.json index dadd2837eb..4360553fe5 100644 --- a/schemas/v3.0/schema.json +++ b/schemas/v3.0/schema.json @@ -1,7 +1,7 @@ { "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", diff --git a/schemas/v3.0/schema.yaml b/schemas/v3.0/schema.yaml index 2bee05d9a0..8a006dc75b 100644 --- a/schemas/v3.0/schema.yaml +++ b/schemas/v3.0/schema.yaml @@ -1,6 +1,6 @@ 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 diff --git a/schemas/v3.1/dialect/base.schema.json b/schemas/v3.1/dialect/base.schema.json index d54b0d4d7c..762574dd83 100644 --- a/schemas/v3.1/dialect/base.schema.json +++ b/schemas/v3.1/dialect/base.schema.json @@ -1,4 +1,6 @@ { + "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": { @@ -13,7 +15,6 @@ }, "$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" } diff --git a/schemas/v3.1/dialect/base.schema.yaml b/schemas/v3.1/dialect/base.schema.yaml index 8f1bf734cb..81d42a7585 100644 --- a/schemas/v3.1/dialect/base.schema.yaml +++ b/schemas/v3.1/dialect/base.schema.yaml @@ -1,4 +1,6 @@ --- +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 diff --git a/schemas/v3.1/meta/base.schema.json b/schemas/v3.1/meta/base.schema.json index f3ee03fb96..c3b2fea08f 100644 --- a/schemas/v3.1/meta/base.schema.json +++ b/schemas/v3.1/meta/base.schema.json @@ -1,11 +1,12 @@ { + "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": { diff --git a/schemas/v3.1/meta/base.schema.yaml b/schemas/v3.1/meta/base.schema.yaml index 80a662a179..a0de79c5d3 100644 --- a/schemas/v3.1/meta/base.schema.yaml +++ b/schemas/v3.1/meta/base.schema.yaml @@ -1,4 +1,6 @@ --- +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 diff --git a/schemas/v3.1/schema-base.json b/schemas/v3.1/schema-base.json index 03692f631a..c1855b5d41 100644 --- a/schemas/v3.1/schema-base.json +++ b/schemas/v3.1/schema-base.json @@ -1,4 +1,5 @@ { + "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", diff --git a/schemas/v3.1/schema-base.yaml b/schemas/v3.1/schema-base.yaml index 59b43a8531..b0360a7bfd 100644 --- a/schemas/v3.1/schema-base.yaml +++ b/schemas/v3.1/schema-base.yaml @@ -1,3 +1,4 @@ +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' diff --git a/schemas/v3.1/schema.json b/schemas/v3.1/schema.json index dc8dfff965..608721e72d 100644 --- a/schemas/v3.1/schema.json +++ b/schemas/v3.1/schema.json @@ -1,4 +1,5 @@ { + "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", diff --git a/schemas/v3.1/schema.yaml b/schemas/v3.1/schema.yaml index 112f504e1c..c9e0155f66 100644 --- a/schemas/v3.1/schema.yaml +++ b/schemas/v3.1/schema.yaml @@ -1,3 +1,4 @@ +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'