Releases · OAI/Arazzo-Specification

The OAI is pleased to announce the official release of the Arazzo Specification 1.0.1!

What's Changed

Fix example documents for LoginAndRetrievePets workflow by @apalm in #214
Fix example issues by @frankkilcommins in #260
Fix retryAfter description to match available types by @frankkilcommins in #230
Fix type in WorkflowId description by @frankkilcommins in #301
Improve clarity around workflowId in success and failure actions by @frankkilcommins in #301
Use RFC 9110 instead of RFC 7230 for Header Field guidance by @frankkilcommins in #301
Use RFC 9110 instead of RFC 7231 for payload (or request content) guidance by @frankkilcommins in #301
sourceDescription typo and emphasis on MUST by @jeremyfiel in #234
fix typo in Step Object description by @bpedro in #249
Remove mentions of message from the expression syntax for 1.0.* by @frankkilcommins in #269
Remove body from possible values of the in field within ParameterObject by @frankkilcommins in #284
Fix typo in Step Object operationPath fixed field description by @frankkilcommins in #284

JSON Schema

Add JSON Schema for the Arazzo Specification by @jeremyfiel in #230

Infrastructure Items

respec build script: create minor-version symlinks by @ralfhandl in #289
schema-publish workflow by @ralfhandl in #290
Temporary fix for schema-publish.yaml: reduce list of reviewers by @ralfhandl in #294
spec build workflow: dynamically determine latest spec version by @ralfhandl in #296
Workflows with app-generated access token by @ralfhandl in #302

New Contributors

@apalm made their first contribution in #214
@bpedro made their first contribution in #249

Full Changelog: 1.0.0...1.0.1

The OAI is pleased to announce the official release of the Arazzo Specification 1.0.0!

What's Changed

The initial stable version of the Arazzo specification, which is the cumulative work of the following items:

Updating ReadMe with Charter, participants and getting involved details by @frankkilcommins in #6
Proposal that we can submit to main OAI repo by @ndenny in #1
Splitting Champion from Contributors by @kinlane in #11
Create use-case-template.yml by @namdeirf in #16
Create CODE_OF_CONDUCT.md. by @namdeirf in #15
Rename CODE_OF_CONDUCT.md. to CODE_OF_CONDUCT.md by @namdeirf in #18
Delete CODE_OF_CONDUCT.md by @namdeirf in #25
Draft version minor enrichment by @kevin-postman in #29
Add coupon example by @shaisachs in #32
consistent quotes around cookie by @shaisachs in #33
Adding more examples and typo fixes by @frankkilcommins in #34
Fix ReadMe typos by @frankkilcommins in #35
link description update by @frankkilcommins in #37
Update scope image and ReadMe clean up by @frankkilcommins in #38
fix: mechanical changes only for ReSpec consumption by @MikeRalphson in #39
Create validate-markdown.yaml workflow by @MikeRalphson in #40
Merging main before reviewing other PRs by @frankkilcommins in #56
Components proposal by @shaisachs in #51
Disambiguate workflows by @shaisachs in #59
Components Section for reusability by @frankkilcommins in #57
Additional clarity on sourceDocument referencing. by @frankkilcommins in #63
Add extension support to Success/ Failure Objects by @frankkilcommins in #68
Frankkilcommins/issue66 by @frankkilcommins in #69
Remove AsyncAPI support from initial draft by @frankkilcommins in #70
Harden-expression-and-condition-capabilities by @frankkilcommins in #77
Settle on "Workflows Description" by @frankkilcommins in #79
fix use of workflow output in pet store example by @shaisachs in #58
Merge example changes to main by @frankkilcommins in #81
docs: move Parameter Object spec extensions under the fields definition by @char0n in #83
chore: Tidy up object extension doc location by @frankkilcommins in #86
chore: Add security and IANA considerations by @frankkilcommins in #88
Typo by @ralfhandl in #89
Superfluous comma by @ralfhandl in #90
Monospace for workflows fixed field by @ralfhandl in #92
Simplify "Reference Objects $ref keywords" to "Reference Objects" by @ralfhandl in #93
Link to JSON Schema Validation by @ralfhandl in #94
Chore: Change Parameter.target to string by @frankkilcommins in #87
Hyphen added by @ralfhandl in #91
Double-quotes around literal field values by @ralfhandl in #102
Section Criterion Object: links to sections where it can be used by @ralfhandl in #103
Monospace the double quotes of a literal string value by @ralfhandl in #101
operationRef matching referenced OpenAPI description by @ralfhandl in #95
chore: improve info.version description by @frankkilcommins in #98
chore: remove ABNF rules related to AsyncAPI by @frankkilcommins in #110
chore: force case insensitivity for string comparisons by @frankkilcommins in #111
chore: enforce stepId to be must be within current workflow by @frankkilcommins in #112
chore: resolve ToC issues by @frankkilcommins in #113
Indicate specification is prerelease by @frankkilcommins in #120
Move explanation regarding similar criteria for success/failure action objects to step by @frankkilcommins in #121
Align FailureAction.Retry-After with the Retry-After response HTTP header by @frankkilcommins in #122
Parameter Object: Revisit in verbiage remove workflow as option (infer instead) by @frankkilcommins in #123
workflowsSpec MUST be used for interpretation by @frankkilcommins in #133
Enforce Reference Object value overrides to avoid possible disregards by @frankkilcommins in #135
clarify how to reference operationId and workflowId in case of clashes by @frankkilcommins in #125
Better to explicitly state stepId must be mandatory within a workflow by @frankkilcommins in #134
Component Object should be Components Object by @frankkilcommins in #136
Fix the fragments for OAS 3.1 spec references by @handrews in #146
Update use of APImetrics name by @ndenny in #141
Swap inputs and parameters to match schema by @ndenny in #142
Fix target values to be valid JSON Pointers by @ndenny in #143
add in property to parameters by @frankkilcommins in #148
Clarify Parameter target JSON Pointer by @frankkilcommins in #147
Specification Path expressions for operations with no OperationI ID by @ndenny in #144
Added README to provide details on existing examples and provide addi… by @kevinduffey in #151
Chore: fix pet-coupons.workflow.yaml example by @frankkilcommins in #158
feat: remove support for dependsOn for v1.0.0 by @frankkilcommins in #159
chore: suggest multilevel parameters by @DmitryAnansky in #155
Remove references to WHATWG to avoid confusion by @ndenny in #145
Adjust Step Parameters desc to cater for Workflow parameters addition by @frankkilcommins in #169
feat: add dependsOn capability for workflow level by @frankkilcommins in #164
feat: Add Request Body Object by @frankkilcommins in #162
Clarity on referencing Components Parameters by @frankkilcommins in #149
feat: Reusable Success and Failure Actions by @frankkilcommins in #171
chore: Remove tbd and update Worklfow successActions and failureActions to take advantage of Reusable Objects by @frankkilcommins in #174
feat: Add support for XPath and versions of XPath and JSON Path for Criterion expressions by @frankkilcommins in #172
Remove mutual exclusivity constraint between payload and pointers. Rename to replacements by @frankkilcommins in #183
chore: fix example indentation by @frankkilcommins in #187
Consolidate reusable parameters and reusable objects. by @frankkilcommins in #182
update specification to take care of Arazzo (Tapestry) name change. by @frankkilcommins in #189
feat: support for respec html generation by @frankkilcommins in #192
...