From 35be7d18be670371a710a8e80266beca21a63139 Mon Sep 17 00:00:00 2001 From: Jeremy Fiel <32110157+jeremyfiel@users.noreply.github.com> Date: Thu, 21 Nov 2024 22:24:31 +0000 Subject: [PATCH] feat(spec): update `$comment` symlinks and root description --- schemas/v1.0/schema.json | 32 ++++++++++++++++---------------- schemas/v1.0/schema.yaml | 33 ++++++++++++++++----------------- 2 files changed, 32 insertions(+), 33 deletions(-) diff --git a/schemas/v1.0/schema.json b/schemas/v1.0/schema.json index fc213e3..d4905a1 100644 --- a/schemas/v1.0/schema.json +++ b/schemas/v1.0/schema.json @@ -1,7 +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", + "description": "The description of Arazzo v1.0.x documents", "type": "object", "properties": { "arazzo": { @@ -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": { @@ -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": { @@ -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": { @@ -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": { @@ -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": { @@ -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": { @@ -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": { @@ -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": { @@ -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": { @@ -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": { @@ -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": { @@ -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": { @@ -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": { @@ -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" } } diff --git a/schemas/v1.0/schema.yaml b/schemas/v1.0/schema.yaml index 231a1a7..2b73291 100644 --- a/schemas/v1.0/schema.yaml +++ b/schemas/v1.0/schema.yaml @@ -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: @@ -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: @@ -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 @@ -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: @@ -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) @@ -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: @@ -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, @@ -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: @@ -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: @@ -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: @@ -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: @@ -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: @@ -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: @@ -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: @@ -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'