diff --git a/.changeset/moody-years-return.md b/.changeset/moody-years-return.md new file mode 100644 index 0000000000..5001a52b7a --- /dev/null +++ b/.changeset/moody-years-return.md @@ -0,0 +1,5 @@ +--- +"@redocly/openapi-core": patch +--- + +Added validation to ensure only Arazzo version 1.0.1 is used, helping users stay on the supported version. diff --git a/__tests__/bundle/bundle-arazzo-valid-test-description/museum.yaml b/__tests__/bundle/bundle-arazzo-valid-test-description/museum.yaml index d98913b45f..51f9740f55 100644 --- a/__tests__/bundle/bundle-arazzo-valid-test-description/museum.yaml +++ b/__tests__/bundle/bundle-arazzo-valid-test-description/museum.yaml @@ -1,4 +1,4 @@ -arazzo: 1.0.0 +arazzo: 1.0.1 info: title: Redocly Museum API Tickets description: >- diff --git a/__tests__/bundle/bundle-arazzo-valid-test-description/snapshot.js b/__tests__/bundle/bundle-arazzo-valid-test-description/snapshot.js index b01933747f..6efd1e0435 100644 --- a/__tests__/bundle/bundle-arazzo-valid-test-description/snapshot.js +++ b/__tests__/bundle/bundle-arazzo-valid-test-description/snapshot.js @@ -6,7 +6,7 @@ info: description: A part of imaginary, but delightful Museum API for interacting with museum services and information. Built with love by Redocly. version: 1.0.0 components: {} -arazzo: 1.0.0 +arazzo: 1.0.1 sourceDescriptions: - name: museum-api type: openapi diff --git a/__tests__/lint/arazzo-not-valid-test-description/museum.yaml b/__tests__/lint/arazzo-not-valid-test-description/museum.yaml index aee814eadc..5933e30412 100644 --- a/__tests__/lint/arazzo-not-valid-test-description/museum.yaml +++ b/__tests__/lint/arazzo-not-valid-test-description/museum.yaml @@ -1,4 +1,4 @@ -arazzo: 1.0.0 +arazzo: 1.0.1 sourceDescriptions: - name: museum-api diff --git a/__tests__/lint/arazzo-not-valid-test-description/snapshot.js b/__tests__/lint/arazzo-not-valid-test-description/snapshot.js index f3a4a359de..5d77a61f9d 100644 --- a/__tests__/lint/arazzo-not-valid-test-description/snapshot.js +++ b/__tests__/lint/arazzo-not-valid-test-description/snapshot.js @@ -9,7 +9,7 @@ validating museum.yaml... The field \`info\` must be present on this level. - 1 | arazzo: 1.0.0 + 1 | arazzo: 1.0.1 | ^^^^^^^^^^^^^ 2 | | ^ diff --git a/__tests__/lint/arazzo-type-extensions-with-plugin/museum.yaml b/__tests__/lint/arazzo-type-extensions-with-plugin/museum.yaml index a516fdc077..4878f7a85f 100644 --- a/__tests__/lint/arazzo-type-extensions-with-plugin/museum.yaml +++ b/__tests__/lint/arazzo-type-extensions-with-plugin/museum.yaml @@ -1,4 +1,4 @@ -arazzo: 1.0.0 +arazzo: 1.0.1 info: title: Redocly Museum API Tickets description: >- diff --git a/__tests__/lint/arazzo-valid-test-description/museum.yaml b/__tests__/lint/arazzo-valid-test-description/museum.yaml index 5ed360bb4a..0347d09f7c 100644 --- a/__tests__/lint/arazzo-valid-test-description/museum.yaml +++ b/__tests__/lint/arazzo-valid-test-description/museum.yaml @@ -1,4 +1,4 @@ -arazzo: 1.0.0 +arazzo: 1.0.1 info: title: Redocly Museum API Tickets description: >- diff --git a/docs/rules/arazzo/sourceDescriptions-not-empty.md b/docs/rules/arazzo/sourceDescriptions-not-empty.md index 0ac7e67213..83687ec917 100644 --- a/docs/rules/arazzo/sourceDescriptions-not-empty.md +++ b/docs/rules/arazzo/sourceDescriptions-not-empty.md @@ -36,7 +36,7 @@ rules: Example of a **correct** usage: ```yaml Correct example -arazzo: '1.0.0' +arazzo: '1.0.1' info: title: Cool API version: 1.0.0 diff --git a/docs/rules/spot/spot-supported-versions.md b/docs/rules/spot/spot-supported-versions.md index e7670ace2b..f12e7442b7 100644 --- a/docs/rules/spot/spot-supported-versions.md +++ b/docs/rules/spot/spot-supported-versions.md @@ -36,7 +36,7 @@ arazzoRules: Example of a **correct** entry: ```yaml Object example -arazzo: 1.0.0 +arazzo: 1.0.1 ``` ## Related rules diff --git a/packages/core/src/rules/arazzo/__tests__/criteria-unique.test.ts b/packages/core/src/rules/arazzo/__tests__/criteria-unique.test.ts index 0938e3a60c..75ff22ce60 100644 --- a/packages/core/src/rules/arazzo/__tests__/criteria-unique.test.ts +++ b/packages/core/src/rules/arazzo/__tests__/criteria-unique.test.ts @@ -6,7 +6,7 @@ import { BaseResolver } from '../../../resolve'; describe('Arazzo criteria-unique', () => { const document = parseYamlToDocument( outdent` - arazzo: '1.0.0' + arazzo: '1.0.1' info: title: Cool API version: 1.0.0 diff --git a/packages/core/src/rules/arazzo/__tests__/no-criteria-xpath.test.ts b/packages/core/src/rules/arazzo/__tests__/no-criteria-xpath.test.ts index f9e08dd777..5d32592d05 100644 --- a/packages/core/src/rules/arazzo/__tests__/no-criteria-xpath.test.ts +++ b/packages/core/src/rules/arazzo/__tests__/no-criteria-xpath.test.ts @@ -6,7 +6,7 @@ import { BaseResolver } from '../../../resolve'; describe('Arazzo no-criteria-xpath', () => { const document = parseYamlToDocument( outdent` - arazzo: '1.0.0' + arazzo: '1.0.1' info: title: Cool API version: 1.0.0 diff --git a/packages/core/src/rules/arazzo/__tests__/parameters-unique.test.ts b/packages/core/src/rules/arazzo/__tests__/parameters-unique.test.ts index f8b5062849..bdd48f5e7f 100644 --- a/packages/core/src/rules/arazzo/__tests__/parameters-unique.test.ts +++ b/packages/core/src/rules/arazzo/__tests__/parameters-unique.test.ts @@ -6,7 +6,7 @@ import { BaseResolver } from '../../../resolve'; describe('Arazzo parameters-unique', () => { const document = parseYamlToDocument( outdent` - arazzo: '1.0.0' + arazzo: '1.0.1' info: title: Cool API version: 1.0.0 diff --git a/packages/core/src/rules/arazzo/__tests__/requestBody-replacements-unique.test.ts b/packages/core/src/rules/arazzo/__tests__/requestBody-replacements-unique.test.ts index 508310485a..d6d7fcc6e5 100644 --- a/packages/core/src/rules/arazzo/__tests__/requestBody-replacements-unique.test.ts +++ b/packages/core/src/rules/arazzo/__tests__/requestBody-replacements-unique.test.ts @@ -6,7 +6,7 @@ import { BaseResolver } from '../../../resolve'; describe('Arazzo requestBody-replacements-unique', () => { const document = parseYamlToDocument( outdent` - arazzo: '1.0.0' + arazzo: '1.0.1' info: title: Cool API version: 1.0.0 diff --git a/packages/core/src/rules/arazzo/__tests__/source-description-type.test.ts b/packages/core/src/rules/arazzo/__tests__/source-description-type.test.ts index 79e6eedc27..344f2186a6 100644 --- a/packages/core/src/rules/arazzo/__tests__/source-description-type.test.ts +++ b/packages/core/src/rules/arazzo/__tests__/source-description-type.test.ts @@ -6,7 +6,7 @@ import { BaseResolver } from '../../../resolve'; describe('Arazzo sourceDescription-type', () => { const document = parseYamlToDocument( outdent` - arazzo: '1.0.0' + arazzo: '1.0.1' info: title: Cool API version: 1.0.0 diff --git a/packages/core/src/rules/arazzo/__tests__/sourceDescription-name-unique.test.ts b/packages/core/src/rules/arazzo/__tests__/sourceDescription-name-unique.test.ts index 1fdf4f33fd..6a5078bfa2 100644 --- a/packages/core/src/rules/arazzo/__tests__/sourceDescription-name-unique.test.ts +++ b/packages/core/src/rules/arazzo/__tests__/sourceDescription-name-unique.test.ts @@ -6,7 +6,7 @@ import { BaseResolver } from '../../../resolve'; describe('Arazzo sourceDescription-name-unique', () => { const document = parseYamlToDocument( outdent` - arazzo: '1.0.0' + arazzo: '1.0.1' info: title: Cool API version: 1.0.0 diff --git a/packages/core/src/rules/arazzo/__tests__/sourceDescriptions-not-empty.test.ts b/packages/core/src/rules/arazzo/__tests__/sourceDescriptions-not-empty.test.ts index 8be5ff7889..48d32ffd89 100644 --- a/packages/core/src/rules/arazzo/__tests__/sourceDescriptions-not-empty.test.ts +++ b/packages/core/src/rules/arazzo/__tests__/sourceDescriptions-not-empty.test.ts @@ -6,7 +6,7 @@ import { BaseResolver } from '../../../resolve'; describe('Arazzo sourceDescriptions-not-empty', () => { const document1 = parseYamlToDocument( outdent` - arazzo: '1.0.0' + arazzo: '1.0.1' info: title: Cool API version: 1.0.0 @@ -38,7 +38,7 @@ describe('Arazzo sourceDescriptions-not-empty', () => { const document2 = parseYamlToDocument( outdent` - arazzo: '1.0.0' + arazzo: '1.0.1' info: title: Cool API version: 1.0.0 diff --git a/packages/core/src/rules/arazzo/__tests__/spot-supported-versions.test.ts b/packages/core/src/rules/arazzo/__tests__/spot-supported-versions.test.ts index 9e83beb295..3658d920eb 100644 --- a/packages/core/src/rules/arazzo/__tests__/spot-supported-versions.test.ts +++ b/packages/core/src/rules/arazzo/__tests__/spot-supported-versions.test.ts @@ -81,7 +81,7 @@ describe('Arazzo spot-supported-versions', () => { "source": "arazzo.yaml", }, ], - "message": "Only 1.0.0, 1.0.1 Arazzo versions are supported by Spot.", + "message": "Only 1.0.1 Arazzo version is supported by Spot.", "ruleId": "spot-supported-versions", "severity": "error", "suggest": [], diff --git a/packages/core/src/rules/arazzo/__tests__/step-onFailure-unique.test.ts b/packages/core/src/rules/arazzo/__tests__/step-onFailure-unique.test.ts index 8e8e92cd55..2636c6d036 100644 --- a/packages/core/src/rules/arazzo/__tests__/step-onFailure-unique.test.ts +++ b/packages/core/src/rules/arazzo/__tests__/step-onFailure-unique.test.ts @@ -6,7 +6,7 @@ import { BaseResolver } from '../../../resolve'; describe('Arazzo step-onFailure-unique', () => { const document = parseYamlToDocument( outdent` - arazzo: '1.0.0' + arazzo: '1.0.1' info: title: Cool API version: 1.0.0 diff --git a/packages/core/src/rules/arazzo/__tests__/step-onSuccess-unique.test.ts b/packages/core/src/rules/arazzo/__tests__/step-onSuccess-unique.test.ts index 00aa6b9279..96a1681cec 100644 --- a/packages/core/src/rules/arazzo/__tests__/step-onSuccess-unique.test.ts +++ b/packages/core/src/rules/arazzo/__tests__/step-onSuccess-unique.test.ts @@ -6,7 +6,7 @@ import { BaseResolver } from '../../../resolve'; describe('Arazzo step-onSuccess-unique', () => { const document = parseYamlToDocument( outdent` - arazzo: '1.0.0' + arazzo: '1.0.1' info: title: Cool API version: 1.0.0 diff --git a/packages/core/src/rules/arazzo/__tests__/stepId-unique.test.ts b/packages/core/src/rules/arazzo/__tests__/stepId-unique.test.ts index 153beb9773..49d1cee5fc 100644 --- a/packages/core/src/rules/arazzo/__tests__/stepId-unique.test.ts +++ b/packages/core/src/rules/arazzo/__tests__/stepId-unique.test.ts @@ -6,7 +6,7 @@ import { BaseResolver } from '../../../resolve'; describe('Arazzo stepId-unique', () => { const document = parseYamlToDocument( outdent` - arazzo: '1.0.0' + arazzo: '1.0.1' info: title: Cool API version: 1.0.0 diff --git a/packages/core/src/rules/arazzo/__tests__/workflow-dependsOn.test.ts b/packages/core/src/rules/arazzo/__tests__/workflow-dependsOn.test.ts index cf740908a7..3d2d2f0767 100644 --- a/packages/core/src/rules/arazzo/__tests__/workflow-dependsOn.test.ts +++ b/packages/core/src/rules/arazzo/__tests__/workflow-dependsOn.test.ts @@ -6,7 +6,7 @@ import { BaseResolver } from '../../../resolve'; describe('Arazzo workflow-dependsOn', () => { const document = parseYamlToDocument( outdent` - arazzo: '1.0.0' + arazzo: '1.0.1' info: title: Cool API version: 1.0.0 @@ -65,7 +65,7 @@ describe('Arazzo workflow-dependsOn', () => { const documentWithNotExistingWorkflows = parseYamlToDocument( outdent` - arazzo: 1.0.0 + arazzo: 1.0.1 info: title: Redocly Museum API Test Workflow description: >- diff --git a/packages/core/src/rules/arazzo/__tests__/workflowId-unique.test.ts b/packages/core/src/rules/arazzo/__tests__/workflowId-unique.test.ts index e418d7b7a7..4464c0c6d2 100644 --- a/packages/core/src/rules/arazzo/__tests__/workflowId-unique.test.ts +++ b/packages/core/src/rules/arazzo/__tests__/workflowId-unique.test.ts @@ -6,7 +6,7 @@ import { BaseResolver } from '../../../resolve'; describe('Arazzo workflowId-unique', () => { const document = parseYamlToDocument( outdent` - arazzo: '1.0.0' + arazzo: '1.0.1' info: title: Cool API version: 1.0.0 diff --git a/packages/core/src/typings/arazzo.ts b/packages/core/src/typings/arazzo.ts index 54d9db7c82..a683904eb3 100644 --- a/packages/core/src/typings/arazzo.ts +++ b/packages/core/src/typings/arazzo.ts @@ -142,7 +142,7 @@ export interface Workflow { } export interface ArazzoDefinition { - arazzo: '1.0.0'; + arazzo: '1.0.1'; info: InfoObject; sourceDescriptions: SourceDescription[]; workflows: Workflow[]; @@ -169,4 +169,4 @@ export interface ArazzoDefinition { export const VERSION_PATTERN = /^1\.0\.\d+(-.+)?$/; -export const ARAZZO_VERSIONS_SUPPORTED_BY_SPOT = ['1.0.0', '1.0.1']; +export const ARAZZO_VERSIONS_SUPPORTED_BY_SPOT = ['1.0.1']; diff --git a/resources/arazzo.yaml b/resources/arazzo.yaml index db32f08da4..552664a741 100644 --- a/resources/arazzo.yaml +++ b/resources/arazzo.yaml @@ -1,4 +1,4 @@ -arazzo: 1.0.0 +arazzo: 1.0.1 info: title: Redocly Museum API Test Workflow description: >- diff --git a/resources/museum-tickets.arazzo.yaml b/resources/museum-tickets.arazzo.yaml index 1f1b101f03..62b783058b 100644 --- a/resources/museum-tickets.arazzo.yaml +++ b/resources/museum-tickets.arazzo.yaml @@ -1,4 +1,4 @@ -arazzo: 1.0.0 +arazzo: 1.0.1 info: title: Redocly Museum Tickets Workflow description: >-