Skip to content

chore: updated arazzo version to the supported #1899

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
DmitryAnansky merged 2 commits into from
Feb 10, 2025
Merged

chore: updated arazzo version to the supported #1899

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
96aeaf3
chore: updated arazzo version to the supported
DmitryAnansky Feb 10, 2025
3154592
chore: revert snapshots
DmitryAnansky Feb 10, 2025
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
5 changes: 5 additions & 0 deletions .changeset/moody-years-return.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
2 changes: 1 addition & 1 deletion __tests__/bundle/bundle-arazzo-valid-test-description/museum.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
arazzo: 1.0.0
arazzo: 1.0.1
info:
title: Redocly Museum API Tickets
description: >-
Expand Down
2 changes: 1 addition & 1 deletion __tests__/bundle/bundle-arazzo-valid-test-description/snapshot.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion __tests__/lint/arazzo-not-valid-test-description/museum.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
arazzo: 1.0.0
arazzo: 1.0.1

sourceDescriptions:
- name: museum-api
Expand Down
2 changes: 1 addition & 1 deletion __tests__/lint/arazzo-not-valid-test-description/snapshot.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
| ^
Expand Down
2 changes: 1 addition & 1 deletion __tests__/lint/arazzo-type-extensions-with-plugin/museum.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
arazzo: 1.0.0
arazzo: 1.0.1
info:
title: Redocly Museum API Tickets
description: >-
Expand Down
2 changes: 1 addition & 1 deletion __tests__/lint/arazzo-valid-test-description/museum.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
arazzo: 1.0.0
arazzo: 1.0.1
info:
title: Redocly Museum API Tickets
description: >-
Expand Down
2 changes: 1 addition & 1 deletion docs/rules/arazzo/sourceDescriptions-not-empty.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/rules/spot/spot-supported-versions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ arazzoRules:
Example of a **correct** entry:

```yaml Object example
arazzo: 1.0.0
arazzo: 1.0.1
```

## Related rules
Expand Down
2 changes: 1 addition & 1 deletion packages/core/src/rules/arazzo/__tests__/criteria-unique.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion packages/core/src/rules/arazzo/__tests__/no-criteria-xpath.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion packages/core/src/rules/arazzo/__tests__/parameters-unique.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion packages/core/src/rules/arazzo/__tests__/requestBody-replacements-unique.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion packages/core/src/rules/arazzo/__tests__/source-description-type.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion packages/core/src/rules/arazzo/__tests__/sourceDescription-name-unique.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions packages/core/src/rules/arazzo/__tests__/sourceDescriptions-not-empty.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion packages/core/src/rules/arazzo/__tests__/spot-supported-versions.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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": [],
Expand Down
2 changes: 1 addition & 1 deletion packages/core/src/rules/arazzo/__tests__/step-onFailure-unique.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion packages/core/src/rules/arazzo/__tests__/step-onSuccess-unique.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion packages/core/src/rules/arazzo/__tests__/stepId-unique.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions packages/core/src/rules/arazzo/__tests__/workflow-dependsOn.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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: >-
Expand Down
2 changes: 1 addition & 1 deletion packages/core/src/rules/arazzo/__tests__/workflowId-unique.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions packages/core/src/typings/arazzo.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ export interface Workflow {
}

export interface ArazzoDefinition {
arazzo: '1.0.0';
arazzo: '1.0.1';
info: InfoObject;
sourceDescriptions: SourceDescription[];
workflows: Workflow[];
Expand All @@ -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'];
2 changes: 1 addition & 1 deletion resources/arazzo.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
arazzo: 1.0.0
arazzo: 1.0.1
info:
title: Redocly Museum API Test Workflow
description: >-
Expand Down
2 changes: 1 addition & 1 deletion resources/museum-tickets.arazzo.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
arazzo: 1.0.0
arazzo: 1.0.1
info:
title: Redocly Museum Tickets Workflow
description: >-
Expand Down
Loading