Skip to content

Updates to the JSON Schema - symlinks and root description #285

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
frankkilcommins merged 1 commit into from
Dec 16, 2024
Merged

Updates to the JSON Schema - symlinks and root description #285

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
32 changes: 16 additions & 16 deletions schemas/v1.0/schema.json
View file
Open in desktop
Copy link
Collaborator

@ralfhandl ralfhandl Nov 22, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@frankkilcommins Should the JSON version be removed?

OAS only maintains the YAML representation and produces the JSON representation on-the-fly when publishing the schema.

Copy link
Contributor Author

@jeremyfiel jeremyfiel Nov 22, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Arazzo doesn't have the full publishing process just yet

Copy link
Collaborator

@ralfhandl ralfhandl Nov 25, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will be added with #290

Copy link
Collaborator

@frankkilcommins frankkilcommins Dec 16, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Happy to remove once the automation is setup.

Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"$id": "https://spec.openapis.org/arazzo/1.0/schema/2024-08-01",
Copy link
Contributor Author

@jeremyfiel jeremyfiel Nov 21, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we may also want to consider the $id WORK-IN-PROGRESS for schema development purposes. Overlay and OAS have included changing this to the deployment date with a build script on merge

"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The description of OpenAPI Initiative Arazzo v1.0.0 documents without schema validation, as defined by https://spec.openapis.org/arazzo/v1.0.0",
"description": "The description of Arazzo v1.0.x documents",
"type": "object",
"properties": {
"arazzo": {
Expand Down Expand Up @@ -44,7 +44,7 @@
"unevaluatedProperties": false,
"$defs": {
"info": {
"$comment": "https://spec.openapis.org/arazzo/v1.0.0#info-object",
"$comment": "https://spec.openapis.org/arazzo/v1.0#info-object",
"description": "Provides metadata about the Arazzo description",
"type": "object",
"properties": {
Expand Down Expand Up @@ -73,7 +73,7 @@
"unevaluatedProperties": false
},
"source-description-object": {
"$comment": "https://spec.openapis.org/arazzo/v1.0.0#source-description-object",
"$comment": "https://spec.openapis.org/arazzo/v1.0#source-description-object",
"description": "Describes a source description (such as an OpenAPI description) that will be referenced by one or more workflows described within an Arazzo description",
"type": "object",
"properties": {
Expand Down Expand Up @@ -103,7 +103,7 @@
"unevaluatedProperties": false
},
"workflow-object": {
"$comment": "https://spec.openapis.org/arazzo/v1.0.0#workflow-object",
"$comment": "https://spec.openapis.org/arazzo/v1.0#workflow-object",
"description": "Describes the steps to be taken across one or more APIs to achieve an objective",
"type": "object",
"properties": {
Expand Down Expand Up @@ -204,7 +204,7 @@
"unevaluatedProperties": false
},
"step-object": {
"$comment": "https://spec.openapis.org/arazzo/v1.0.0#step-object'",
"$comment": "https://spec.openapis.org/arazzo/v1.0#step-object'",
"description": "Describes a single workflow step which MAY be a call to an API operation (OpenAPI Operation Object or another Workflow Object)",
"type": "object",
"properties": {
Expand Down Expand Up @@ -371,7 +371,7 @@
"unevaluatedProperties": false
},
"request-body-object": {
"$comment": "https://spec.openapis.org/arazzo/v1.0.0#request-body-object",
"$comment": "https://spec.openapis.org/arazzo/v1.0#request-body-object",
"description": "The request body to pass to an operation as referenced by operationId or operationPath",
"type": "object",
"properties": {
Expand All @@ -393,7 +393,7 @@
"unevaluatedProperties": false
},
"criterion-object": {
"$comment": "https://spec.openapis.org/arazzo/v1.0.0#criterion-object",
"$comment": "https://spec.openapis.org/arazzo/v1.0#criterion-object",
"description": "An object used to specify the context, conditions, and condition types that can be used to prove or satisfy assertions specified in Step Object successCriteria, Success Action Object criteria, and Failure Action Object criteria",
"type": "object",
"properties": {
Expand Down Expand Up @@ -438,7 +438,7 @@
"unevaluatedProperties": false
},
"criterion-expression-type-object": {
"$comment": "https://spec.openapis.org/arazzo/v1.0.0#criterion-expression-type-object",
"$comment": "https://spec.openapis.org/arazzo/v1.0#criterion-expression-type-object",
"description": "An object used to describe the type and version of an expression used within a Criterion Object",
"type": "object",
"properties": {
Expand Down Expand Up @@ -505,7 +505,7 @@
"$ref": "#/$defs/specification-extensions"
},
"success-action-object": {
"$comment": "https://spec.openapis.org/arazzo/v1.0.0#success-action-object",
"$comment": "https://spec.openapis.org/arazzo/v1.0#success-action-object",
"description": "A single success action which describes an action to take upon success of a workflow step",
"type": "object",
"properties": {
Expand Down Expand Up @@ -571,7 +571,7 @@
"unevaluatedProperties": false
},
"failure-action-object": {
"$comment": "https://spec.openapis.org/arazzo/v1.0.0#failure-action-object",
"$comment": "https://spec.openapis.org/arazzo/v1.0#failure-action-object",
"description": "A single failure action which describes an action to take upon failure of a workflow step",
"type": "object",
"properties": {
Expand Down Expand Up @@ -664,7 +664,7 @@
"unevaluatedProperties": false
},
"reusable-object": {
"$comment": "https://spec.openapis.org/arazzo/v1.0.0#reusable-object",
"$comment": "https://spec.openapis.org/arazzo/v1.0#reusable-object",
"description": "A simple object to allow referencing of objects contained within the Components Object",
"type": "object",
"properties": {
Expand All @@ -690,7 +690,7 @@
"unevaluatedProperties": false
},
"parameter-object": {
"$comment": "https://spec.openapis.org/arazzo/v1.0.0#parameter-object",
"$comment": "https://spec.openapis.org/arazzo/v1.0#parameter-object",
"description": "Describes a single step parameter",
"type": "object",
"properties": {
Expand Down Expand Up @@ -728,7 +728,7 @@
"unevaluatedProperties": false
},
"payload-replacement-object": {
"$comment": "https://spec.openapis.org/arazzo/v1.0.0#payload-replacement-object",
"$comment": "https://spec.openapis.org/arazzo/v1.0#payload-replacement-object",
"description": "Describes a location within a payload (e.g., a request body) and a value to set within the location",
"type": "object",
"properties": {
Expand All @@ -749,7 +749,7 @@
"$ref": "#/$defs/specification-extensions"
},
"components-object": {
"$comment": "https://spec.openapis.org/arazzo/v1.0.0#components-object",
"$comment": "https://spec.openapis.org/arazzo/v1.0#components-object",
"description": "Holds a set of reusable objects for different aspects of the Arazzo Specification",
"type": "object",
"properties": {
Expand Down Expand Up @@ -794,14 +794,14 @@
"$ref": "#/$defs/specification-extensions"
},
"specification-extensions": {
"$comment": "https://spec.openapis.org/arazzo/v1.0.0#specification-extensions",
"$comment": "https://spec.openapis.org/arazzo/v1.0#specification-extensions",
"description": "While the Arazzo Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points",
"patternProperties": {
"^x-": true
}
},
"schema": {
"$comment": "https://spec.openapis.org/arazzo/v1.0.0#schema-object",
"$comment": "https://spec.openapis.org/arazzo/v1.0#schema-object",
"$ref": "https://json-schema.org/draft/2020-12/schema"
}
}
Expand Down
33 changes: 16 additions & 17 deletions schemas/v1.0/schema.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
$id: 'https://spec.openapis.org/arazzo/1.0/schema/2024-08-01'
$schema: 'https://json-schema.org/draft/2020-12/schema'
description: |-
The description of OpenAPI Initiative Arazzo v1.0.0 documents
without schema validation, as defined by https://spec.openapis.org/arazzo/v1.0.0
The description of Arazzo v1.0.x documents
type: object
properties:
arazzo:
Expand Down Expand Up @@ -36,7 +35,7 @@ $ref: '#/$defs/specification-extensions'
unevaluatedProperties: false
$defs:
info:
$comment: https://spec.openapis.org/arazzo/v1.0.0#info-object
$comment: https://spec.openapis.org/arazzo/v1.0#info-object
description: Provides metadata about the Arazzo description
type: object
properties:
Expand All @@ -58,7 +57,7 @@ $defs:
$ref: '#/$defs/specification-extensions'
unevaluatedProperties: false
source-description-object:
$comment: https://spec.openapis.org/arazzo/v1.0.0#source-description-object
$comment: https://spec.openapis.org/arazzo/v1.0#source-description-object
description: |-
Describes a source description (such as an OpenAPI description)
that will be referenced by one or more workflows described within
Expand All @@ -84,7 +83,7 @@ $defs:
$ref: '#/$defs/specification-extensions'
unevaluatedProperties: false
workflow-object:
$comment: https://spec.openapis.org/arazzo/v1.0.0#workflow-object
$comment: https://spec.openapis.org/arazzo/v1.0#workflow-object
description: Describes the steps to be taken across one or more APIs to achieve an objective
type: object
properties:
Expand Down Expand Up @@ -150,7 +149,7 @@ $defs:
$ref: '#/$defs/specification-extensions'
unevaluatedProperties: false
step-object:
$comment: https://spec.openapis.org/arazzo/v1.0.0#step-object'
$comment: https://spec.openapis.org/arazzo/v1.0#step-object'
description: |-
Describes a single workflow step which MAY be a call to an
API operation (OpenAPI Operation Object or another Workflow Object)
Expand Down Expand Up @@ -246,7 +245,7 @@ $defs:
$ref: '#/$defs/specification-extensions'
unevaluatedProperties: false
request-body-object:
$comment: https://spec.openapis.org/arazzo/v1.0.0#request-body-object
$comment: https://spec.openapis.org/arazzo/v1.0#request-body-object
description: The request body to pass to an operation as referenced by operationId or operationPath
type: object
properties:
Expand All @@ -263,7 +262,7 @@ $defs:
$ref: '#/$defs/specification-extensions'
unevaluatedProperties: false
criterion-object:
$comment: https://spec.openapis.org/arazzo/v1.0.0#criterion-object
$comment: https://spec.openapis.org/arazzo/v1.0#criterion-object
description: |-
An object used to specify the context, conditions, and condition types
that can be used to prove or satisfy assertions specified in Step Object successCriteria,
Expand Down Expand Up @@ -296,7 +295,7 @@ $defs:
$ref: '#/$defs/specification-extensions'
unevaluatedProperties: false
criterion-expression-type-object:
$comment: https://spec.openapis.org/arazzo/v1.0.0#criterion-expression-type-object
$comment: https://spec.openapis.org/arazzo/v1.0#criterion-expression-type-object
description: An object used to describe the type and version of an expression used within a Criterion Object
type: object
properties:
Expand Down Expand Up @@ -337,7 +336,7 @@ $defs:
- xpath-30
$ref: '#/$defs/specification-extensions'
success-action-object:
$comment: https://spec.openapis.org/arazzo/v1.0.0#success-action-object
$comment: https://spec.openapis.org/arazzo/v1.0#success-action-object
description: A single success action which describes an action to take upon success of a workflow step
type: object
properties:
Expand Down Expand Up @@ -379,7 +378,7 @@ $defs:
$ref: '#/$defs/specification-extensions'
unevaluatedProperties: false
failure-action-object:
$comment: https://spec.openapis.org/arazzo/v1.0.0#failure-action-object
$comment: https://spec.openapis.org/arazzo/v1.0#failure-action-object
description: A single failure action which describes an action to take upon failure of a workflow step
type: object
properties:
Expand Down Expand Up @@ -438,7 +437,7 @@ $defs:
$ref: '#/$defs/specification-extensions'
unevaluatedProperties: false
reusable-object:
$comment: https://spec.openapis.org/arazzo/v1.0.0#reusable-object
$comment: https://spec.openapis.org/arazzo/v1.0#reusable-object
description: A simple object to allow referencing of objects contained within the Components Object
type: object
properties:
Expand All @@ -458,7 +457,7 @@ $defs:
- reference
unevaluatedProperties: false
parameter-object:
$comment: https://spec.openapis.org/arazzo/v1.0.0#parameter-object
$comment: https://spec.openapis.org/arazzo/v1.0#parameter-object
description: Describes a single step parameter
type: object
properties:
Expand Down Expand Up @@ -488,7 +487,7 @@ $defs:
$ref: '#/$defs/specification-extensions'
unevaluatedProperties: false
payload-replacement-object:
$comment: https://spec.openapis.org/arazzo/v1.0.0#payload-replacement-object
$comment: https://spec.openapis.org/arazzo/v1.0#payload-replacement-object
description: Describes a location within a payload (e.g., a request body) and a value to set within the location
type: object
properties:
Expand All @@ -504,7 +503,7 @@ $defs:
unevaluatedProperties: false
$ref: '#/$defs/specification-extensions'
components-object:
$comment: https://spec.openapis.org/arazzo/v1.0.0#components-object
$comment: https://spec.openapis.org/arazzo/v1.0#components-object
description: Holds a set of reusable objects for different aspects of the Arazzo Specification
type: object
properties:
Expand Down Expand Up @@ -536,10 +535,10 @@ $defs:
unevaluatedProperties: false
$ref: '#/$defs/specification-extensions'
specification-extensions:
$comment: https://spec.openapis.org/arazzo/v1.0.0#specification-extensions
$comment: https://spec.openapis.org/arazzo/v1.0#specification-extensions
description: While the Arazzo Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points
patternProperties:
'^x-': true
schema:
$comment: https://spec.openapis.org/arazzo/v1.0.0#schema-object
$comment: https://spec.openapis.org/arazzo/v1.0#schema-object
$ref: 'https://json-schema.org/draft/2020-12/schema'