Skip to content

add description to all schemas #2802

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 24, 2022
Merged

add description to all schemas #2802

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion schemas/v3.0/schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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",
Expand Down
2 changes: 1 addition & 1 deletion schemas/v3.0/schema.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down
3 changes: 2 additions & 1 deletion schemas/v3.1/dialect/base.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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": {
Expand All @@ -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" }
Expand Down
3 changes: 2 additions & 1 deletion schemas/v3.1/dialect/base.schema.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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
3 changes: 2 additions & 1 deletion schemas/v3.1/meta/base.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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": {
Expand Down
3 changes: 2 additions & 1 deletion schemas/v3.1/meta/base.schema.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
---
title: OAS Base vocabulary
description: A JSON Schema Vocabulary used in the OpenAPI Schema Dialect
$defs:
discriminator:
$ref: '#/$defs/extensible'
Expand Down Expand Up @@ -57,7 +59,6 @@ properties:
$ref: '#/$defs/external-docs'
xml:
$ref: '#/$defs/xml'
title: OAS Base vocabulary
type:
- object
- boolean
1 change: 1 addition & 0 deletions schemas/v3.1/schema-base.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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",
Expand Down
1 change: 1 addition & 0 deletions schemas/v3.1/schema-base.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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'

Expand Down
1 change: 1 addition & 0 deletions schemas/v3.1/schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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",
Expand Down
1 change: 1 addition & 0 deletions schemas/v3.1/schema.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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'

Expand Down