Skip to content

schemas: add WORK-IN-PROGRESS placeholders, don't mention patch numbers, update terminology #4146

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 6 commits into from
Oct 24, 2024
Merged

schemas: add WORK-IN-PROGRESS placeholders, don't mention patch numbers, update terminology #4146

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
492b9cc
schemas: WORK-IN-PROGRESS placeholders, terminology
handrews Oct 18, 2024
8e23d02
Update the schema READMEs for current practice
handrews Oct 21, 2024
c0f07c9
"base" can't be both a file and a directory
handrews Oct 22, 2024
cc1995d
Merge remote-tracking branch 'upstream/main' into pr/4146
ralfhandl Oct 22, 2024
b928227
Link to issue tracking "latest" schema access
handrews Oct 22, 2024
520a7c3
Update schemas/v3.1/schema.yaml
ralfhandl Oct 22, 2024
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
4 changes: 2 additions & 2 deletions 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
id: https://spec.openapis.org/oas/3.0/schema/WORK-IN-PROGRESS
$schema: http://json-schema.org/draft-04/schema#
description: The description of OpenAPI v3.0.x documents, as defined by https://spec.openapis.org/oas/v3.0.3
description: The description of OpenAPI v3.0.x Documents
type: object
required:
- openapi
Expand Down
6 changes: 3 additions & 3 deletions schemas/v3.1/dialect/base.schema.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
$id: https://spec.openapis.org/oas/3.1/dialect/base
$id: https://spec.openapis.org/oas/3.1/dialect/base/WORK-IN-PROGRESS
$schema: https://json-schema.org/draft/2020-12/schema

title: OpenAPI 3.1 Schema Object Dialect
description: A JSON Schema dialect describing schemas found in OpenAPI documents
description: A JSON Schema dialect describing schemas found in OpenAPI v3.1 Descriptions

$dynamicAnchor: meta

Expand All @@ -18,4 +18,4 @@ $vocabulary:

allOf:
- $ref: https://json-schema.org/draft/2020-12/schema
- $ref: https://spec.openapis.org/oas/3.1/meta/base
- $ref: https://spec.openapis.org/oas/3.1/meta/base/WORK-IN-PROGRESS
4 changes: 2 additions & 2 deletions schemas/v3.1/meta/base.schema.yaml
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.1/meta/base
$id: https://spec.openapis.org/oas/3.1/meta/base/WORK-IN-PROGRESS
$schema: https://json-schema.org/draft/2020-12/schema

title: OAS Base vocabulary
title: OAS Base Vocabulary
description: A JSON Schema Vocabulary used in the OpenAPI Schema Dialect

$dynamicAnchor: meta
Expand Down
10 changes: 5 additions & 5 deletions schemas/v3.1/schema-base.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
$id: 'https://spec.openapis.org/oas/3.1/schema-base/2022-10-07'
$id: 'https://spec.openapis.org/oas/3.1/schema-base/WORK-IN-PROGRESS'
$schema: 'https://json-schema.org/draft/2020-12/schema'

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
description: The description of OpenAPI v3.1.x Documents using the OpenAPI JSON Schema dialect

$ref: 'https://spec.openapis.org/oas/3.1/schema/2022-10-07'
$ref: 'https://spec.openapis.org/oas/3.1/schema/WORK-IN-PROGRESS'
properties:
jsonSchemaDialect:
$ref: '#/$defs/dialect'

$defs:
dialect:
const: 'https://spec.openapis.org/oas/3.1/dialect/base'
const: 'https://spec.openapis.org/oas/3.1/dialect/base/WORK-IN-PROGRESS'

schema:
$dynamicAnchor: meta
$ref: 'https://spec.openapis.org/oas/3.1/dialect/base'
$ref: 'https://spec.openapis.org/oas/3.1/dialect/base/WORK-IN-PROGRESS'
properties:
$schema:
$ref: '#/$defs/dialect'
6 changes: 3 additions & 3 deletions schemas/v3.1/schema.yaml
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.1/schema/2022-10-07'
$id: 'https://spec.openapis.org/oas/3.1/schema/WORK-IN-PROGRESS'
$schema: 'https://json-schema.org/draft/2020-12/schema'

description: The description of OpenAPI v3.1.x documents without schema validation, as defined by https://spec.openapis.org/oas/v3.1.0
description: The description of OpenAPI v3.1.x Documents without Schema Object validation

type: object
properties:
Expand All @@ -13,7 +13,7 @@ properties:
jsonSchemaDialect:
type: string
format: uri
default: 'https://spec.openapis.org/oas/3.1/dialect/base'
default: 'https://spec.openapis.org/oas/3.1/dialect/base/WORK-IN-PROGRESS'
servers:
type: array
items:
Expand Down