Skip to content

Commit 8f61336

Browse files
chore(infra): archive schema and update actions, scripts etc.
1 parent 28e29bd commit 8f61336

25 files changed

+3273
-2440
lines changed

.github/workflows/respec.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ jobs:
6363
delete-branch: true
6464
path: deploy
6565
labels: Housekeeping
66-
reviewers: darrelmiller,webron,earth2marsh,webron,lornajane,mikekistler,miqui,handrews,karenetheridge,ralfhandl
66+
reviewers: darrelmiller,webron,earth2marsh,lornajane,mikekistler,miqui,handrews,karenetheridge,ralfhandl
6767
title: Arazzo - Update ReSpec-rendered specification versions
6868
commit-message: Update ReSpec-rendered specification versions
6969
signoff: true

.github/workflows/schema-publish.yaml

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
name: schema-publish
22

3-
# author: @ralfhandl
3+
# author: @ralfhandl, @frankkilcommins
44

55
#
66
# This workflow copies the x.y schemas to the gh-pages branch
@@ -10,7 +10,11 @@ name: schema-publish
1010
on:
1111
push:
1212
branches:
13-
- main
13+
- 'v[0-9].[0-9]-dev'
14+
paths:
15+
- 'src/schemas/validation/*.yaml'
16+
- 'scripts/schema-publish.sh'
17+
- '.github/workflows/schema-publish.yaml'
1418
workflow_dispatch: {}
1519

1620
jobs:
@@ -33,7 +37,7 @@ jobs:
3337

3438
- uses: actions/setup-node@v4 # setup Node.js
3539
with:
36-
node-version: 20.x
40+
node-version: 22.x
3741

3842
- name: Install dependencies
3943
run: npm ci
@@ -57,10 +61,10 @@ jobs:
5761
delete-branch: true
5862
path: deploy
5963
labels: Housekeeping,Schema
60-
reviewers: darrelmiller,webron,earth2marsh,lornajane,mikekistler,miqui,handrews,ralfhandl
64+
reviewers: darrelmiller,webron,earth2marsh,lornajane,mikekistler,miqui,ralfhandl,handrews,karenetheridge
6165
title: Arazzo - Publish Schema Iterations
6266
commit-message: New Arazzo schema iterations
6367
signoff: true
6468
body: |
6569
This pull request is automatically triggered by GitHub action `schema-publish` in the OAI/Arazzo-Specification repo.
66-
The `schemas/**/*.yaml` files have changed and JSON files are automatically generated.
70+
The `src/schemas/validation/*.yaml` files have changed and JSON files are automatically generated.

.github/workflows/schema-tests.yaml

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,7 @@ jobs:
2929
node-version: '20.x'
3030

3131
- name: Install dependencies from main
32-
run: |
33-
# git checkout remotes/origin/main -- package.json package-lock.json #TODO: uncomment with subsequent PR
34-
npm ci
32+
run: npm ci
33+
3534
- name: Run tests
36-
run: npm test
35+
run: npm run test

.github/workflows/validate-markdown.yaml

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@ name: validate-markdown
44
# Issue: https://github.com/OAI/OpenAPI-Specification/issues/2130
55

66
#
7-
# This workflow validates files in the versions directory matching 1.*.md
7+
# This workflow validates markdown files in the project root.
8+
# It also validates the work-in-progress specification file src/arazzo.md with slightly different rules.
89
#
910

1011
# run this on push to any branch and creation of pull-requests
@@ -16,9 +17,16 @@ jobs:
1617
runs-on: ubuntu-latest
1718

1819
steps:
19-
- uses: actions/checkout@v2 # checkout repo content
20-
- uses: actions/setup-node@v1 # setup Node.js
20+
- uses: actions/checkout@v4 # checkout repo content
2121
with:
22-
node-version: '18.x'
23-
- name: Validate markdown
24-
run: npx mdv versions/1.*.md
22+
fetch-depth: 0
23+
24+
- uses: actions/setup-node@v4 # setup Node.js
25+
with:
26+
node-version: '20.x'
27+
28+
- name: Lint work-in-progress spec
29+
run: npx --yes markdownlint-cli2 --config spec.markdownlint.yaml src/arazzo.md
30+
31+
- name: Lint other files
32+
run: npx --yes markdownlint-cli2 *.md

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ target
77
atlassian-ide-plugin.xml
88
node_modules/
99
deploy/
10+
deploy-preview/
1011
history
1112
Gemfile.lock
1213
coverage/

.markdownlint.yaml

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# First heading is a top-level heading
2+
MD002: true
3+
4+
# Heading style (ATX is leading # symbols)
5+
MD003:
6+
style: atx
7+
8+
# Unordered list symbol can be anything
9+
MD004: false
10+
11+
# Unordered list indentation size
12+
MD007:
13+
indent: 2
14+
15+
# Allow additional blank lines
16+
MD012: false
17+
18+
# Maximum line length
19+
MD013:
20+
line_length: 800
21+
tables: false
22+
23+
# Headings need blank lines before and after
24+
MD022: true
25+
26+
# Duplicate headings are allowed
27+
MD024: false
28+
29+
# Surround lists with blank lines
30+
MD032: true
31+
32+
# Allow inline HTML
33+
MD033: false

MAINTAINERS.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1+
# Arazzo Specification Maintainers
2+
13
## Active
4+
25
* Frank Kilcommins [@frankkilcommins](https://github.com/frankkilcommins)
36
* Nick Denny [@ndenny](https://github.com/ndenny)
4-
* Kevin Duffey [@kevinduffey](https://github.com/kevinduffey)
7+
* Kevin Duffey [@kevinduffey](https://github.com/kevinduffey)

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ The OpenAPI Initiative encourages participation from individuals and companies a
4242
- [Bi-weekly Call](https://github.com/OAI/Arazzo-Specification/discussions/5) - Wednesdays at 09:00 AM PDT
4343
- [Discussions](https://github.com/OAI/Arazzo-Specification/discussions) - Use the GitHub discussions to ask questions, provide opinions and engage with the group
4444
- [Issues](https://github.com/OAI/Arazzo-Specification/issues) - Feel free to submit a Github issue with any question or comment about the working group
45-
- Slack - if you have access to the OpenAPI slack workspace, then join the `arazzo` channel. If you do not have access, you're welcome to join by clicking [here](https://communityinviter.com/apps/open-api/openapi)
45+
- Slack - if you have access to the OpenAPI slack workspace, then join the `arazzo` channel. If you do not have access, [you're welcome to join](https://communityinviter.com/apps/open-api/openapi)
4646

4747
## Licensing
4848

SPECIAL_INTEREST_GROUP.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,17 +10,18 @@ For more information, see [OAI Special Interest Groups](https://github.com/OAI/O
1010

1111
## Workflows Special Interest Group - Charter / Motivation
1212

13-
Being able to express specific sequences of calls and articulate the dependencies between them to achieve a particular goal is desirable in the context of an API specification.
13+
Being able to express specific sequences of calls and articulate the dependencies between them to achieve a particular goal is desirable in the context of an API specification.
1414

15-
Our aim is to propose an enhancement to the current OpenAPI, or accompanying specification (or means), that can define sequences of calls and their dependencies to be expressed in the context of delivering a particular outcome or set of outcomes.
15+
Our aim is to propose an enhancement to the current OpenAPI, or accompanying specification (or means), that can define sequences of calls and their dependencies to be expressed in the context of delivering a particular outcome or set of outcomes.
1616

17-
The creation of the SIG-Workflows group is inspired by the need to store sequences of calls in the context of specific tests, and in order to communicate the particulars of a complex set of security related calls such as when using OAuth2 and the Financial-grade API security profile of OpenID Connect.
17+
The creation of the SIG-Workflows group is inspired by the need to store sequences of calls in the context of specific tests, and in order to communicate the particulars of a complex set of security related calls such as when using OAuth2 and the Financial-grade API security profile of OpenID Connect.
1818

1919
However, such a definition will be useful for understanding how to implement any dependent sequence of functional calls for any user of an API such as authorization calls, redirects and web hooks in order to achieve a certain technical or functional outcome.
2020

2121
Optimally, it should be possible to articulate these workflows in a human and machine readable manner, thus improving the capability of API specifications to tell the story of the API in a manner that can improve the consuming developer experience and understanding of an API specified using OpenAPI (or other supported specifications).
2222

23-
**Key focus areas**
23+
### Key focus areas
24+
2425
- **Context** - How to define quickly and easily what goal and key functions of an API are, and how to represent that in a specification
2526
- **Workflows** - Handling key and complex sequences which may involve the reuse of endpoints for multiple uses, like token calls in a FAPI compliant sequence, in both a human and machine readable way, supporting both understanding and automation
2627
- **Tooling** - How to best integrate to tools and provide machine readable context for those tools so that the spec can integrate with the tools used by developers

_archive_/schemas/v1.0/readme.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Archive of outdated JSON Schema Files
2+
3+
> [!TIP]
4+
> JSON Schema files for validating Arazzo descriptions using current Arazzo versions are available at [https://spec.openapis.org/#arazzo-schemas](https://spec.openapis.org/#arazzo-schemas).
5+
>
6+
> These schema files are maintained in the `src/schemas` folder of the corresponding `vX.Y-dev` branch in this repository.
7+
8+
> [!CAUTION]
9+
> Schema files in this folder are not maintained any more and are not intended for productive use.

0 commit comments

Comments
 (0)