Skip to content

Commit a620024

Browse files
jeremyfieljeremyfiel
authored
feat(spec): update $comment symlinks and root description (#285)
1 parent d02cff6 commit a620024

2 files changed

Lines changed: 32 additions & 33 deletions

File tree

‎schemas/v1.0/schema.json‎

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"$id": "https://spec.openapis.org/arazzo/1.0/schema/2024-08-01",
33
"$schema": "https://json-schema.org/draft/2020-12/schema",
4-
"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",
4+
"description": "The description of Arazzo v1.0.x documents",
55
"type": "object",
66
"properties": {
77
"arazzo": {
@@ -44,7 +44,7 @@
4444
"unevaluatedProperties": false,
4545
"$defs": {
4646
"info": {
47-
"$comment": "https://spec.openapis.org/arazzo/v1.0.0#info-object",
47+
"$comment": "https://spec.openapis.org/arazzo/v1.0#info-object",
4848
"description": "Provides metadata about the Arazzo description",
4949
"type": "object",
5050
"properties": {
@@ -73,7 +73,7 @@
7373
"unevaluatedProperties": false
7474
},
7575
"source-description-object": {
76-
"$comment": "https://spec.openapis.org/arazzo/v1.0.0#source-description-object",
76+
"$comment": "https://spec.openapis.org/arazzo/v1.0#source-description-object",
7777
"description": "Describes a source description (such as an OpenAPI description) that will be referenced by one or more workflows described within an Arazzo description",
7878
"type": "object",
7979
"properties": {
@@ -103,7 +103,7 @@
103103
"unevaluatedProperties": false
104104
},
105105
"workflow-object": {
106-
"$comment": "https://spec.openapis.org/arazzo/v1.0.0#workflow-object",
106+
"$comment": "https://spec.openapis.org/arazzo/v1.0#workflow-object",
107107
"description": "Describes the steps to be taken across one or more APIs to achieve an objective",
108108
"type": "object",
109109
"properties": {
@@ -204,7 +204,7 @@
204204
"unevaluatedProperties": false
205205
},
206206
"step-object": {
207-
"$comment": "https://spec.openapis.org/arazzo/v1.0.0#step-object'",
207+
"$comment": "https://spec.openapis.org/arazzo/v1.0#step-object'",
208208
"description": "Describes a single workflow step which MAY be a call to an API operation (OpenAPI Operation Object or another Workflow Object)",
209209
"type": "object",
210210
"properties": {
@@ -371,7 +371,7 @@
371371
"unevaluatedProperties": false
372372
},
373373
"request-body-object": {
374-
"$comment": "https://spec.openapis.org/arazzo/v1.0.0#request-body-object",
374+
"$comment": "https://spec.openapis.org/arazzo/v1.0#request-body-object",
375375
"description": "The request body to pass to an operation as referenced by operationId or operationPath",
376376
"type": "object",
377377
"properties": {
@@ -393,7 +393,7 @@
393393
"unevaluatedProperties": false
394394
},
395395
"criterion-object": {
396-
"$comment": "https://spec.openapis.org/arazzo/v1.0.0#criterion-object",
396+
"$comment": "https://spec.openapis.org/arazzo/v1.0#criterion-object",
397397
"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",
398398
"type": "object",
399399
"properties": {
@@ -438,7 +438,7 @@
438438
"unevaluatedProperties": false
439439
},
440440
"criterion-expression-type-object": {
441-
"$comment": "https://spec.openapis.org/arazzo/v1.0.0#criterion-expression-type-object",
441+
"$comment": "https://spec.openapis.org/arazzo/v1.0#criterion-expression-type-object",
442442
"description": "An object used to describe the type and version of an expression used within a Criterion Object",
443443
"type": "object",
444444
"properties": {
@@ -505,7 +505,7 @@
505505
"$ref": "#/$defs/specification-extensions"
506506
},
507507
"success-action-object": {
508-
"$comment": "https://spec.openapis.org/arazzo/v1.0.0#success-action-object",
508+
"$comment": "https://spec.openapis.org/arazzo/v1.0#success-action-object",
509509
"description": "A single success action which describes an action to take upon success of a workflow step",
510510
"type": "object",
511511
"properties": {
@@ -571,7 +571,7 @@
571571
"unevaluatedProperties": false
572572
},
573573
"failure-action-object": {
574-
"$comment": "https://spec.openapis.org/arazzo/v1.0.0#failure-action-object",
574+
"$comment": "https://spec.openapis.org/arazzo/v1.0#failure-action-object",
575575
"description": "A single failure action which describes an action to take upon failure of a workflow step",
576576
"type": "object",
577577
"properties": {
@@ -664,7 +664,7 @@
664664
"unevaluatedProperties": false
665665
},
666666
"reusable-object": {
667-
"$comment": "https://spec.openapis.org/arazzo/v1.0.0#reusable-object",
667+
"$comment": "https://spec.openapis.org/arazzo/v1.0#reusable-object",
668668
"description": "A simple object to allow referencing of objects contained within the Components Object",
669669
"type": "object",
670670
"properties": {
@@ -690,7 +690,7 @@
690690
"unevaluatedProperties": false
691691
},
692692
"parameter-object": {
693-
"$comment": "https://spec.openapis.org/arazzo/v1.0.0#parameter-object",
693+
"$comment": "https://spec.openapis.org/arazzo/v1.0#parameter-object",
694694
"description": "Describes a single step parameter",
695695
"type": "object",
696696
"properties": {
@@ -728,7 +728,7 @@
728728
"unevaluatedProperties": false
729729
},
730730
"payload-replacement-object": {
731-
"$comment": "https://spec.openapis.org/arazzo/v1.0.0#payload-replacement-object",
731+
"$comment": "https://spec.openapis.org/arazzo/v1.0#payload-replacement-object",
732732
"description": "Describes a location within a payload (e.g., a request body) and a value to set within the location",
733733
"type": "object",
734734
"properties": {
@@ -749,7 +749,7 @@
749749
"$ref": "#/$defs/specification-extensions"
750750
},
751751
"components-object": {
752-
"$comment": "https://spec.openapis.org/arazzo/v1.0.0#components-object",
752+
"$comment": "https://spec.openapis.org/arazzo/v1.0#components-object",
753753
"description": "Holds a set of reusable objects for different aspects of the Arazzo Specification",
754754
"type": "object",
755755
"properties": {
@@ -794,14 +794,14 @@
794794
"$ref": "#/$defs/specification-extensions"
795795
},
796796
"specification-extensions": {
797-
"$comment": "https://spec.openapis.org/arazzo/v1.0.0#specification-extensions",
797+
"$comment": "https://spec.openapis.org/arazzo/v1.0#specification-extensions",
798798
"description": "While the Arazzo Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points",
799799
"patternProperties": {
800800
"^x-": true
801801
}
802802
},
803803
"schema": {
804-
"$comment": "https://spec.openapis.org/arazzo/v1.0.0#schema-object",
804+
"$comment": "https://spec.openapis.org/arazzo/v1.0#schema-object",
805805
"$ref": "https://json-schema.org/draft/2020-12/schema"
806806
}
807807
}

‎schemas/v1.0/schema.yaml‎

Lines changed: 16 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
$id: 'https://spec.openapis.org/arazzo/1.0/schema/2024-08-01'
22
$schema: 'https://json-schema.org/draft/2020-12/schema'
33
description: |-
4-
The description of OpenAPI Initiative Arazzo v1.0.0 documents
5-
without schema validation, as defined by https://spec.openapis.org/arazzo/v1.0.0
4+
The description of Arazzo v1.0.x documents
65
type: object
76
properties:
87
arazzo:
@@ -36,7 +35,7 @@ $ref: '#/$defs/specification-extensions'
3635
unevaluatedProperties: false
3736
$defs:
3837
info:
39-
$comment: https://spec.openapis.org/arazzo/v1.0.0#info-object
38+
$comment: https://spec.openapis.org/arazzo/v1.0#info-object
4039
description: Provides metadata about the Arazzo description
4140
type: object
4241
properties:
@@ -58,7 +57,7 @@ $defs:
5857
$ref: '#/$defs/specification-extensions'
5958
unevaluatedProperties: false
6059
source-description-object:
61-
$comment: https://spec.openapis.org/arazzo/v1.0.0#source-description-object
60+
$comment: https://spec.openapis.org/arazzo/v1.0#source-description-object
6261
description: |-
6362
Describes a source description (such as an OpenAPI description)
6463
that will be referenced by one or more workflows described within
@@ -84,7 +83,7 @@ $defs:
8483
$ref: '#/$defs/specification-extensions'
8584
unevaluatedProperties: false
8685
workflow-object:
87-
$comment: https://spec.openapis.org/arazzo/v1.0.0#workflow-object
86+
$comment: https://spec.openapis.org/arazzo/v1.0#workflow-object
8887
description: Describes the steps to be taken across one or more APIs to achieve an objective
8988
type: object
9089
properties:
@@ -150,7 +149,7 @@ $defs:
150149
$ref: '#/$defs/specification-extensions'
151150
unevaluatedProperties: false
152151
step-object:
153-
$comment: https://spec.openapis.org/arazzo/v1.0.0#step-object'
152+
$comment: https://spec.openapis.org/arazzo/v1.0#step-object'
154153
description: |-
155154
Describes a single workflow step which MAY be a call to an
156155
API operation (OpenAPI Operation Object or another Workflow Object)
@@ -246,7 +245,7 @@ $defs:
246245
$ref: '#/$defs/specification-extensions'
247246
unevaluatedProperties: false
248247
request-body-object:
249-
$comment: https://spec.openapis.org/arazzo/v1.0.0#request-body-object
248+
$comment: https://spec.openapis.org/arazzo/v1.0#request-body-object
250249
description: The request body to pass to an operation as referenced by operationId or operationPath
251250
type: object
252251
properties:
@@ -263,7 +262,7 @@ $defs:
263262
$ref: '#/$defs/specification-extensions'
264263
unevaluatedProperties: false
265264
criterion-object:
266-
$comment: https://spec.openapis.org/arazzo/v1.0.0#criterion-object
265+
$comment: https://spec.openapis.org/arazzo/v1.0#criterion-object
267266
description: |-
268267
An object used to specify the context, conditions, and condition types
269268
that can be used to prove or satisfy assertions specified in Step Object successCriteria,
@@ -296,7 +295,7 @@ $defs:
296295
$ref: '#/$defs/specification-extensions'
297296
unevaluatedProperties: false
298297
criterion-expression-type-object:
299-
$comment: https://spec.openapis.org/arazzo/v1.0.0#criterion-expression-type-object
298+
$comment: https://spec.openapis.org/arazzo/v1.0#criterion-expression-type-object
300299
description: An object used to describe the type and version of an expression used within a Criterion Object
301300
type: object
302301
properties:
@@ -337,7 +336,7 @@ $defs:
337336
- xpath-30
338337
$ref: '#/$defs/specification-extensions'
339338
success-action-object:
340-
$comment: https://spec.openapis.org/arazzo/v1.0.0#success-action-object
339+
$comment: https://spec.openapis.org/arazzo/v1.0#success-action-object
341340
description: A single success action which describes an action to take upon success of a workflow step
342341
type: object
343342
properties:
@@ -379,7 +378,7 @@ $defs:
379378
$ref: '#/$defs/specification-extensions'
380379
unevaluatedProperties: false
381380
failure-action-object:
382-
$comment: https://spec.openapis.org/arazzo/v1.0.0#failure-action-object
381+
$comment: https://spec.openapis.org/arazzo/v1.0#failure-action-object
383382
description: A single failure action which describes an action to take upon failure of a workflow step
384383
type: object
385384
properties:
@@ -438,7 +437,7 @@ $defs:
438437
$ref: '#/$defs/specification-extensions'
439438
unevaluatedProperties: false
440439
reusable-object:
441-
$comment: https://spec.openapis.org/arazzo/v1.0.0#reusable-object
440+
$comment: https://spec.openapis.org/arazzo/v1.0#reusable-object
442441
description: A simple object to allow referencing of objects contained within the Components Object
443442
type: object
444443
properties:
@@ -458,7 +457,7 @@ $defs:
458457
- reference
459458
unevaluatedProperties: false
460459
parameter-object:
461-
$comment: https://spec.openapis.org/arazzo/v1.0.0#parameter-object
460+
$comment: https://spec.openapis.org/arazzo/v1.0#parameter-object
462461
description: Describes a single step parameter
463462
type: object
464463
properties:
@@ -488,7 +487,7 @@ $defs:
488487
$ref: '#/$defs/specification-extensions'
489488
unevaluatedProperties: false
490489
payload-replacement-object:
491-
$comment: https://spec.openapis.org/arazzo/v1.0.0#payload-replacement-object
490+
$comment: https://spec.openapis.org/arazzo/v1.0#payload-replacement-object
492491
description: Describes a location within a payload (e.g., a request body) and a value to set within the location
493492
type: object
494493
properties:
@@ -504,7 +503,7 @@ $defs:
504503
unevaluatedProperties: false
505504
$ref: '#/$defs/specification-extensions'
506505
components-object:
507-
$comment: https://spec.openapis.org/arazzo/v1.0.0#components-object
506+
$comment: https://spec.openapis.org/arazzo/v1.0#components-object
508507
description: Holds a set of reusable objects for different aspects of the Arazzo Specification
509508
type: object
510509
properties:
@@ -536,10 +535,10 @@ $defs:
536535
unevaluatedProperties: false
537536
$ref: '#/$defs/specification-extensions'
538537
specification-extensions:
539-
$comment: https://spec.openapis.org/arazzo/v1.0.0#specification-extensions
538+
$comment: https://spec.openapis.org/arazzo/v1.0#specification-extensions
540539
description: While the Arazzo Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points
541540
patternProperties:
542541
'^x-': true
543542
schema:
544-
$comment: https://spec.openapis.org/arazzo/v1.0.0#schema-object
543+
$comment: https://spec.openapis.org/arazzo/v1.0#schema-object
545544
$ref: 'https://json-schema.org/draft/2020-12/schema'

0 commit comments

Comments
 (0)