Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
56 commits
Select commit Hold shift + click to select a range
3640b90
Adds Legba mention in "Tools that support overlays" section
mpenet Oct 8, 2025
dbc04f3
ci: adds a dependabot configuration to maintain workflow and test pro…
baywet Oct 16, 2025
d0aa0fd
Merge branch 'main' into ci/dependabot-config
ralfhandl Oct 20, 2025
50c6d18
Merge pull request #152 from baywet/ci/dependabot-config
ralfhandl Oct 20, 2025
b760a05
Merge branch 'main' into patch-1
lornajane Oct 20, 2025
8a4d62d
Update workflow to run every Tuesday but only create a meeting every …
lornajane Oct 20, 2025
0a0a145
Merge pull request #149 from mpenet/patch-1
lornajane Oct 20, 2025
f4d2ff2
Bump actions/checkout from 4 to 5
dependabot[bot] Oct 21, 2025
3f46e91
Merge pull request #169 from OAI/dependabot/github_actions/actions/ch…
baywet Oct 21, 2025
a63d5c6
Bump actions/setup-node from 4 to 6
dependabot[bot] Oct 21, 2025
b17251b
Merge pull request #168 from OAI/dependabot/github_actions/actions/se…
baywet Oct 21, 2025
1705471
ci: Update CODEOWNERS to include overlay maintainers
baywet Oct 21, 2025
6af3f8d
Merge pull request #174 from OAI/baywet-patch-1
ralfhandl Oct 21, 2025
a147567
Bump yargs from 17.7.2 to 18.0.0
dependabot[bot] Oct 21, 2025
4e59fd5
Merge pull request #161 from OAI/dependabot/npm_and_yarn/yargs-18.0.0
baywet Oct 21, 2025
a9b1286
Bump highlight.js from 11.10.0 to 11.11.1
dependabot[bot] Oct 21, 2025
3772f45
Merge pull request #167 from OAI/dependabot/npm_and_yarn/highlight.js…
baywet Oct 21, 2025
2fecf02
Bump prettier from 3.3.3 to 3.6.2
dependabot[bot] Oct 21, 2025
ecc07d8
Merge pull request #162 from OAI/dependabot/npm_and_yarn/prettier-3.6.2
baywet Oct 21, 2025
d7814d6
Bump cheerio from 1.0.0 to 1.1.2
dependabot[bot] Oct 21, 2025
94fc881
Merge pull request #159 from OAI/dependabot/npm_and_yarn/cheerio-1.1.2
baywet Oct 21, 2025
9c399f6
Bump yaml from 2.5.0 to 2.8.1
dependabot[bot] Oct 21, 2025
8344a23
Merge pull request #160 from OAI/dependabot/npm_and_yarn/yaml-2.8.1
baywet Oct 21, 2025
570a711
Bump respec from 35.1.1 to 35.6.0
dependabot[bot] Oct 21, 2025
f829f67
Merge pull request #166 from OAI/dependabot/npm_and_yarn/respec-35.6.0
baywet Oct 21, 2025
41bf709
Run respec workflow only if spec versions change
ralfhandl Oct 21, 2025
a791e93
Bump vitest from 2.1.3 to 3.2.4 in the vitest group
dependabot[bot] Oct 21, 2025
6e289b2
Merge pull request #158 from OAI/dependabot/npm_and_yarn/vitest-ec0a6…
baywet Oct 21, 2025
fcdd2da
Bump markdownlint-cli from 0.41.0 to 0.45.0
dependabot[bot] Oct 21, 2025
012056d
Merge pull request #165 from OAI/dependabot/npm_and_yarn/markdownlint…
baywet Oct 21, 2025
cd4285a
Bump actions/create-github-app-token from 1 to 2
dependabot[bot] Oct 21, 2025
9023bdd
Merge branch 'main' into main-respec-file-filter
ralfhandl Oct 21, 2025
93669ce
Merge pull request #170 from OAI/dependabot/github_actions/actions/cr…
baywet Oct 21, 2025
37f9113
Merge branch 'main' into main-respec-file-filter
ralfhandl Oct 21, 2025
29df6f0
Merge pull request #175 from ralfhandl/main-respec-file-filter
baywet Oct 21, 2025
628b586
Bump c8 from 10.1.2 to 10.1.3
dependabot[bot] Oct 21, 2025
9ab3709
Merge pull request #164 from OAI/dependabot/npm_and_yarn/c8-10.1.3
baywet Oct 21, 2025
b80d530
Merge branch 'main' into chore/sync-main-to-v1.1-dev
baywet Oct 21, 2025
38f6036
Merge branch 'main' into chore/sync-main-to-v1.1-dev
baywet Oct 21, 2025
23803ea
Run checks on pull requests
ralfhandl Oct 21, 2025
f49e51f
Merge pull request #178 from ralfhandl/main-run-checks-on-pull-requests
baywet Oct 21, 2025
1014900
ci: adds condition so the publish workflow only runs upstream
baywet Oct 21, 2025
d1e5b36
Merge pull request #179 from OAI/ci/fix-publish-fork
baywet Oct 21, 2025
724bb27
Merge branch 'main' into chore/sync-main-to-v1.1-dev
baywet Oct 21, 2025
c02359a
Merge branch 'main' into adjust-workflow-cron
baywet Oct 21, 2025
4bf3cce
docs: updates cron description
baywet Oct 21, 2025
b8008ce
Merge pull request #171 from lornajane/adjust-workflow-cron
baywet Oct 21, 2025
01738ce
Merge branch 'main' into chore/sync-main-to-v1.1-dev
baywet Oct 21, 2025
aea1bf0
Use same schema coverage as OpenAPI-Specification
ralfhandl Oct 21, 2025
788a618
Refactor test script
ralfhandl Oct 21, 2025
9402c9b
Merge branch 'main' into main-schema-test-coverage
ralfhandl Oct 21, 2025
396d288
Update schema-tests.yaml
ralfhandl Oct 21, 2025
6325dec
Merge pull request #181 from ralfhandl/main-schema-test-coverage
baywet Oct 21, 2025
2811c41
ci: updates node to 22 to stay on a secure version
baywet Oct 21, 2025
b492626
Merge pull request #182 from OAI/ci/node-22
baywet Oct 21, 2025
f0d6cc9
Merge branch 'main' into chore/sync-main-to-v1.1-dev
baywet Oct 21, 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
2 changes: 1 addition & 1 deletion .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -1 +1 @@
* @oai/tsc
* @oai/tsc @OAI/overlay-maintainers
16 changes: 16 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
version: 2
updates:
- package-ecosystem: github-actions
directory: "/"
schedule:
interval: daily
open-pull-requests-limit: 10
- package-ecosystem: npm
directory: "/"
schedule:
interval: daily
open-pull-requests-limit: 10
groups:
vitest:
patterns:
- "*vitest*"
22 changes: 19 additions & 3 deletions .github/workflows/agenda.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,28 +3,44 @@ name: Create meeting template
on:
workflow_dispatch: {}
schedule:
# every two weeks on tuesday at 10AM PST (with DST)
- cron: '0 17 */14 * 2'
# every week on tuesday at 10AM PST (with DST)
- cron: '0 17 * * 2'

jobs:
create-discussion:
permissions:
discussions: write
runs-on: ubuntu-22.04
steps:
- uses: actions/checkout@v4
- uses: actions/checkout@v5
- name: Check if it's an alternate week
id: check-week
run: |
# Get ISO week number (1-53)
WEEK_NUMBER=$(date +%V)
# Check if week number is odd or even to run workflow and create agenda for next week's meeting
if [ $((WEEK_NUMBER % 2)) -eq 0 ]; then
echo "Should run this week (even week: $WEEK_NUMBER)"
echo "should_run=true" >> $GITHUB_OUTPUT
else
echo "Skipping odd week: $WEEK_NUMBER"
echo "should_run=false" >> $GITHUB_OUTPUT
fi
- name: Get agenda text from template
if: steps.check-week.outputs.should_run == 'true'
id: get-agenda
run: |
echo 'AGENDA<<EOF' >> $GITHUB_ENV
cat .github/templates/agenda.md >> $GITHUB_ENV
echo 'EOF' >> $GITHUB_ENV
- name: Get Next Meeting Date
if: steps.check-week.outputs.should_run == 'true'
id: get-next-meeting-date
run: |
NEXT_MEETING_DATE=$(date -d "next Tuesday" +%Y-%m-%d)
echo "NEXT_MEETING_DATE=$NEXT_MEETING_DATE" >> $GITHUB_ENV
- name: Create discussion with agenda
if: steps.check-week.outputs.should_run == 'true'
id: create-repository-discussion
uses: octokit/[email protected]
env:
Expand Down
92 changes: 47 additions & 45 deletions .github/workflows/respec.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,68 +4,70 @@ name: respec
# issue: https://github.com/OAI/OpenAPI-Specification/issues/1564

#
# This workflow updates the respec 'pretty' rendered versions of the spec
# This workflow updates the respec 'pretty' rendered versions of the spec
# on the gh-pages branch when the corresponding markdown files change.
#

# run this on push to main
# run this on push of new spec versions to main
on:
push:
paths:
- "versions/**"
branches:
- main
workflow_dispatch: {}

jobs:
respec:
if: github.repository == 'OAI/Overlay-Specification'

runs-on: ubuntu-22.04

steps:
- name: Generate access token
id: generate-token
uses: actions/create-github-app-token@v1
with:
app-id: ${{ secrets.OAI_SPEC_PUBLISHER_APPID }}
private-key: ${{ secrets.OAI_SPEC_PUBLISHER_PRIVATE_KEY }}
owner: OAI
repositories: OpenAPI-Specification

- uses: actions/checkout@v4 # checkout main branch
with:
fetch-depth: 0
- name: Generate access token
id: generate-token
uses: actions/create-github-app-token@v1
with:
app-id: ${{ secrets.OAI_SPEC_PUBLISHER_APPID }}
private-key: ${{ secrets.OAI_SPEC_PUBLISHER_PRIVATE_KEY }}
owner: OAI
repositories: OpenAPI-Specification

- uses: actions/checkout@v5 # checkout main branch
with:
fetch-depth: 0

- uses: actions/setup-node@v6 # setup Node.js
with:
node-version: "22.x"

- uses: actions/setup-node@v4 # setup Node.js
with:
node-version: '20.x'

- name: Install dependencies
run: npm ci
- name: Install dependencies
run: npm ci

- uses: actions/checkout@v4 # checkout gh-pages branch
with:
token: ${{ steps.generate-token.outputs.token }}
repository: OAI/OpenAPI-Specification # TODO: change to OAI/...
ref: gh-pages
path: deploy
- uses: actions/checkout@v5 # checkout gh-pages branch
with:
token: ${{ steps.generate-token.outputs.token }}
repository: OAI/OpenAPI-Specification # TODO: change to OAI/...
ref: gh-pages
path: deploy

- name: run main script
run: scripts/md2html/build.sh
- name: run main script
run: scripts/md2html/build.sh

- name: Create Pull Request
uses: peter-evans/create-pull-request@v7
with:
token: ${{ steps.generate-token.outputs.token }}
branch: update-overlay-respec-version
base: gh-pages
delete-branch: true
path: deploy
labels: Housekeeping
reviewers: darrelmiller,webron,earth2marsh,lornajane,mikekistler,miqui,handrews,ralfhandl
title: Overlay - Update ReSpec-rendered specification versions
commit-message: Update ReSpec-rendered specification versions
signoff: true
body: |
This pull request is automatically triggered by GitHub action `respec` in the OAI/Overlay-Specification repo.
- name: Create Pull Request
uses: peter-evans/create-pull-request@v7
with:
token: ${{ steps.generate-token.outputs.token }}
branch: update-overlay-respec-version
base: gh-pages
delete-branch: true
path: deploy
labels: Housekeeping
reviewers: darrelmiller,webron,earth2marsh,lornajane,mikekistler,miqui,handrews,ralfhandl
title: Overlay - Update ReSpec-rendered specification versions
commit-message: Update ReSpec-rendered specification versions
signoff: true
body: |
This pull request is automatically triggered by GitHub action `respec` in the OAI/Overlay-Specification repo.

The `versions/*.md` files have changed, so the HTML files are automatically being regenerated.
The `versions/*.md` files have changed, so the HTML files are automatically being regenerated.
11 changes: 6 additions & 5 deletions .github/workflows/schema-publish.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,30 +15,31 @@ on:

jobs:
publish:
if: github.repository == 'OAI/Overlay-Specification'
runs-on: ubuntu-latest

steps:
- name: Generate access token
id: generate-token
uses: actions/create-github-app-token@v1
uses: actions/create-github-app-token@v2
with:
app-id: ${{ secrets.OAI_SPEC_PUBLISHER_APPID }}
private-key: ${{ secrets.OAI_SPEC_PUBLISHER_PRIVATE_KEY }}
owner: OAI
repositories: OpenAPI-Specification

- uses: actions/checkout@v4 # checkout main branch
- uses: actions/checkout@v5 # checkout main branch
with:
fetch-depth: 0

- uses: actions/setup-node@v4 # setup Node.js
- uses: actions/setup-node@v6 # setup Node.js
with:
node-version: 20.x
node-version: "22.x"

- name: Install dependencies
run: npm ci

- uses: actions/checkout@v4 # checkout gh-pages branch
- uses: actions/checkout@v5 # checkout gh-pages branch
with:
token: ${{ steps.generate-token.outputs.token }}
repository: OAI/OpenAPI-Specification
Expand Down
30 changes: 14 additions & 16 deletions .github/workflows/schema-tests.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,30 +8,28 @@ name: schema-tests
# testcases for the metaschemas
#

# run this on push to any branch and creation of pull-requests
on:
push: {}
# run this on pull-requests (creation and updates) and on manual trigger
on:
pull_request: {}
workflow_dispatch: {}

jobs:
test:

runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v4 # checkout repo content
with:
fetch-depth: 0
- uses: actions/checkout@v5 # checkout repo content
with:
fetch-depth: 0

- uses: actions/setup-node@v4 # setup Node.js
with:
node-version: '20.x'
- uses: actions/setup-node@v6 # setup Node.js
with:
node-version: "22.x"

- name: Install dependencies from main
run: |
# git checkout remotes/origin/main -- package.json package-lock.json #TODO: uncomment with subsequent PR
npm ci
- name: Install dependencies
run: npm ci

- name: Run tests
run: npm test
- name: Run tests
run: npm test
env:
BASE: ${{ github.event.pull_request.base.ref }}
33 changes: 17 additions & 16 deletions .github/workflows/validate-markdown.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,25 +7,26 @@ name: validate-markdown
# This workflow validates markdown files in the versions directory matching *.md
#

# run this on push to any branch and creation of pull-requests
on: [push, pull_request]
# run this on pull-requests (creation and updates) and on manual trigger
on:
pull_request: {}
workflow_dispatch: {}

jobs:
mdv:

runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v4 # checkout repo content
with:
fetch-depth: 0
# - name: use the javascript environment from main
# run: |
# git checkout remotes/origin/main -- package.json package-lock.json .markdownlint.yaml
- uses: actions/setup-node@v4 # setup Node.js
with:
node-version: '20.x'
- name: Validate markdown
run: npx --yes mdv versions/*.md
- name: Lint markdown
run: npx --yes markdownlint-cli --config .markdownlint.yaml versions/*.md
- uses: actions/checkout@v5 # checkout repo content
with:
fetch-depth: 0
# - name: use the javascript environment from main
# run: |
# git checkout remotes/origin/main -- package.json package-lock.json .markdownlint.yaml
- uses: actions/setup-node@v6 # setup Node.js
with:
node-version: "22.x"
- name: Validate markdown
run: npx --yes mdv versions/*.md
- name: Lint markdown
run: npx --yes markdownlint-cli --config .markdownlint.yaml versions/*.md
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ If you are looking for tools to use with Overlays, try these:
- [oas-overlay-java](https://github.com/IBM/oas-overlay-java)
- [Specmatic](https://specmatic.io/) - [Docs](https://docs.specmatic.io/documentation/contract_tests.html#overlays)
- [BinkyLabs.OpenApi.Overlays - dotnet](https://github.com/BinkyLabs/openapi-overlays-dotnet)
- [Legba - Clojure OpenAPI toolkit](https://github.com/mpenet/legba?tab=readme-ov-file#openapi-overlay-support)

(Is something missing from the list? Send us a pull request to add it!)

Expand Down
Loading