Skip to content

v3.3-dev: sync with dev#5456

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
oai-spec-publisher merged 8 commits into from
Jul 30, 2026
Merged

v3.3-dev: sync with dev #5456

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
1b3861f
Bump actions/setup-node from 6 to 7
dependabot[bot] Jul 14, 2026
8e166da
Merge pull request #5435 from OAI/dependabot/github_actions/actions/s…
ralfhandl Jul 14, 2026
bb68296
Merge main into dev-sync-with-main
github-actions[bot] Jul 14, 2026
0ee400f
Clarify local validation commands in CONTRIBUTING.md
miqui Jul 23, 2026
5423da4
Merge pull request #5443 from miqui/contributing-local-validation
handrews Jul 30, 2026
fd82831
Merge main into dev-sync-with-main
github-actions[bot] Jul 30, 2026
c2f9d6c
Merge pull request #5436 from OAI/dev-sync-with-main
miqui Jul 30, 2026
388377e
Merge dev into v3.3-dev-sync-with-dev
github-actions[bot] Jul 30, 2026
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/workflows/respec.yaml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -31,7 +31,7 @@ jobs:
with:
fetch-depth: 0

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

Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/schema-publish.yaml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -34,7 +34,7 @@ jobs:
with:
fetch-depth: 0

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

Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/schema-tests.yaml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -23,7 +23,7 @@ jobs:
with:
fetch-depth: 0

- uses: actions/setup-node@v6 # setup Node.js
- uses: actions/setup-node@v7 # setup Node.js
with:
node-version: '24.x'

Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/validate-markdown.yaml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,7 @@ jobs:
steps:
- uses: actions/checkout@v7 # checkout repo content

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

Expand Down
17 changes: 12 additions & 5 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -179,16 +179,23 @@ Draft pull requests can still be reviewed while in draft state.
> [!NOTE]
> `npm run build-src` calls bash scripts. Use [Git Bash](https://gitforwindows.org/) on Windows, or use the Windows Subsystem for Linux (WSL).

The markdown source files are converted to HTML before publishing.
To do this locally, please
Before creating a pull request or marking a draft pull request as ready for review, validate your changes locally:

1. Install [Node.js](https://nodejs.org/)
2. Check out this repo, go to the repo root, and switch to a development branch
3. Execute `npm install` (once, repeat after merging upstream changes)
4. Execute `npm run build-src` after changing `src/oas.md` (this first executes `npm run validate-markdown`, which can also be run separately)
5. Open output file `deploy-preview/oas.html` with a browser and check your changes
4. Run the commands relevant to what you changed:

Please make sure the markdown validates and builds using the above steps before creating a pull request or marking a draft pull request as ready for review.
| Command | What it does |
| ------- | ------------- |
| `npm run validate-markdown` | markdownlint + link check only — fast loop while editing |
| `npm run format-markdown` | auto-fix markdownlint violations |
| `npm run build-src` | full check: validation, HTML build, schema publish |
| `npm test` | runs the JSON Schema and build tooling test suites |

5. After `npm run build-src`, open output file `deploy-preview/oas.html` with a browser and check your changes

Please make sure the markdown validates and builds, and that `npm test` passes, before creating a pull request or marking a draft pull request as ready for review.

## Reviewers

Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
v3.3-dev: sync with dev by oai-spec-publisher[bot] · Pull Request #5456 · OAI/OpenAPI-Specification · GitHub
Skip to content
v3.3-dev: sync with dev#5456

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

oai-spec-publisher
merged 8 commits into

from

Jul 30, 2026
 Merged


v3.3-dev: sync with dev
#5456
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
1b3861f

Bump actions/setup-node from 6 to 7


dependabot[bot] Jul 14, 2026
8e166da

Merge pull request #5435 from OAI/dependabot/github_actions/actions/s…


ralfhandl Jul 14, 2026
bb68296

Merge main into dev-sync-with-main


github-actions[bot] Jul 14, 2026
0ee400f

Clarify local validation commands in CONTRIBUTING.md


miqui Jul 23, 2026
5423da4

Merge pull request #5443 from miqui/contributing-local-validation


handrews Jul 30, 2026
fd82831

Merge main into dev-sync-with-main


github-actions[bot] Jul 30, 2026
c2f9d6c

Merge pull request #5436 from OAI/dev-sync-with-main


miqui Jul 30, 2026
388377e

Merge dev into v3.3-dev-sync-with-dev


github-actions[bot] Jul 30, 2026

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/workflows/respec.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,7 +31,7 @@ jobs:
 with:
 fetch-depth: 0

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

Expand Down

2 changes: 1 addition & 1 deletion
.github/workflows/schema-publish.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,7 +34,7 @@ jobs:
 with:
 fetch-depth: 0

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

Expand Down

2 changes: 1 addition & 1 deletion
.github/workflows/schema-tests.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,7 +23,7 @@ jobs:
 with:
 fetch-depth: 0

 - uses: actions/setup-node@v6 # setup Node.js
 - uses: actions/setup-node@v7 # setup Node.js
 with:
 node-version: '24.x'

Expand Down

2 changes: 1 addition & 1 deletion
.github/workflows/validate-markdown.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,7 @@ jobs:
 steps:
 - uses: actions/checkout@v7 # checkout repo content

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

Expand Down

17 changes: 12 additions & 5 deletions
CONTRIBUTING.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -179,16 +179,23 @@ Draft pull requests can still be reviewed while in draft state.
> [!NOTE]
> `npm run build-src` calls bash scripts. Use [Git Bash](https://gitforwindows.org/) on Windows, or use the Windows Subsystem for Linux (WSL).

The markdown source files are converted to HTML before publishing.
To do this locally, please
Before creating a pull request or marking a draft pull request as ready for review, validate your changes locally:

1. Install [Node.js](https://nodejs.org/)
2. Check out this repo, go to the repo root, and switch to a development branch
3. Execute `npm install` (once, repeat after merging upstream changes)
4. Execute `npm run build-src` after changing `src/oas.md` (this first executes `npm run validate-markdown`, which can also be run separately)
5. Open output file `deploy-preview/oas.html` with a browser and check your changes
4. Run the commands relevant to what you changed:

Please make sure the markdown validates and builds using the above steps before creating a pull request or marking a draft pull request as ready for review.
 | Command | What it does |
 | ------- | ------------- |
 | `npm run validate-markdown` | markdownlint + link check only — fast loop while editing |
 | `npm run format-markdown` | auto-fix markdownlint violations |
 | `npm run build-src` | full check: validation, HTML build, schema publish |
 | `npm test` | runs the JSON Schema and build tooling test suites |

5. After `npm run build-src`, open output file `deploy-preview/oas.html` with a browser and check your changes

Please make sure the markdown validates and builds, and that `npm test` passes, before creating a pull request or marking a draft pull request as ready for review.

## Reviewers

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
v3.3-dev: sync with dev by oai-spec-publisher[bot] · Pull Request #5456 · OAI/OpenAPI-Specification · GitHub
Skip to content
v3.3-dev: sync with dev#5456

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

oai-spec-publisher
merged 8 commits into

from

Jul 30, 2026
 Merged


v3.3-dev: sync with dev
#5456
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
1b3861f

Bump actions/setup-node from 6 to 7


dependabot[bot] Jul 14, 2026
8e166da

Merge pull request #5435 from OAI/dependabot/github_actions/actions/s…


ralfhandl Jul 14, 2026
bb68296

Merge main into dev-sync-with-main


github-actions[bot] Jul 14, 2026
0ee400f

Clarify local validation commands in CONTRIBUTING.md


miqui Jul 23, 2026
5423da4

Merge pull request #5443 from miqui/contributing-local-validation


handrews Jul 30, 2026
fd82831

Merge main into dev-sync-with-main


github-actions[bot] Jul 30, 2026
c2f9d6c

Merge pull request #5436 from OAI/dev-sync-with-main


miqui Jul 30, 2026
388377e

Merge dev into v3.3-dev-sync-with-dev


github-actions[bot] Jul 30, 2026

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/workflows/respec.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,7 +31,7 @@ jobs:
 with:
 fetch-depth: 0

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

Expand Down

2 changes: 1 addition & 1 deletion
.github/workflows/schema-publish.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,7 +34,7 @@ jobs:
 with:
 fetch-depth: 0

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

Expand Down

2 changes: 1 addition & 1 deletion
.github/workflows/schema-tests.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,7 +23,7 @@ jobs:
 with:
 fetch-depth: 0

 - uses: actions/setup-node@v6 # setup Node.js
 - uses: actions/setup-node@v7 # setup Node.js
 with:
 node-version: '24.x'

Expand Down

2 changes: 1 addition & 1 deletion
.github/workflows/validate-markdown.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,7 @@ jobs:
 steps:
 - uses: actions/checkout@v7 # checkout repo content

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

Expand Down

17 changes: 12 additions & 5 deletions
CONTRIBUTING.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -179,16 +179,23 @@ Draft pull requests can still be reviewed while in draft state.
> [!NOTE]
> `npm run build-src` calls bash scripts. Use [Git Bash](https://gitforwindows.org/) on Windows, or use the Windows Subsystem for Linux (WSL).

The markdown source files are converted to HTML before publishing.
To do this locally, please
Before creating a pull request or marking a draft pull request as ready for review, validate your changes locally:

1. Install [Node.js](https://nodejs.org/)
2. Check out this repo, go to the repo root, and switch to a development branch
3. Execute `npm install` (once, repeat after merging upstream changes)
4. Execute `npm run build-src` after changing `src/oas.md` (this first executes `npm run validate-markdown`, which can also be run separately)
5. Open output file `deploy-preview/oas.html` with a browser and check your changes
4. Run the commands relevant to what you changed:

Please make sure the markdown validates and builds using the above steps before creating a pull request or marking a draft pull request as ready for review.
 | Command | What it does |
 | ------- | ------------- |
 | `npm run validate-markdown` | markdownlint + link check only — fast loop while editing |
 | `npm run format-markdown` | auto-fix markdownlint violations |
 | `npm run build-src` | full check: validation, HTML build, schema publish |
 | `npm test` | runs the JSON Schema and build tooling test suites |

5. After `npm run build-src`, open output file `deploy-preview/oas.html` with a browser and check your changes

Please make sure the markdown validates and builds, and that `npm test` passes, before creating a pull request or marking a draft pull request as ready for review.

## Reviewers

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
v3.3-dev: sync with dev by oai-spec-publisher[bot] · Pull Request #5456 · OAI/OpenAPI-Specification · GitHub
Skip to content
v3.3-dev: sync with dev#5456

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

oai-spec-publisher
merged 8 commits into

from

Jul 30, 2026
 Merged


v3.3-dev: sync with dev
#5456
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
1b3861f

Bump actions/setup-node from 6 to 7


dependabot[bot] Jul 14, 2026
8e166da

Merge pull request #5435 from OAI/dependabot/github_actions/actions/s…


ralfhandl Jul 14, 2026
bb68296

Merge main into dev-sync-with-main


github-actions[bot] Jul 14, 2026
0ee400f

Clarify local validation commands in CONTRIBUTING.md


miqui Jul 23, 2026
5423da4

Merge pull request #5443 from miqui/contributing-local-validation


handrews Jul 30, 2026
fd82831

Merge main into dev-sync-with-main


github-actions[bot] Jul 30, 2026
c2f9d6c

Merge pull request #5436 from OAI/dev-sync-with-main


miqui Jul 30, 2026
388377e

Merge dev into v3.3-dev-sync-with-dev


github-actions[bot] Jul 30, 2026

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/workflows/respec.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,7 +31,7 @@ jobs:
 with:
 fetch-depth: 0

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

Expand Down

2 changes: 1 addition & 1 deletion
.github/workflows/schema-publish.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,7 +34,7 @@ jobs:
 with:
 fetch-depth: 0

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

Expand Down

2 changes: 1 addition & 1 deletion
.github/workflows/schema-tests.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,7 +23,7 @@ jobs:
 with:
 fetch-depth: 0

 - uses: actions/setup-node@v6 # setup Node.js
 - uses: actions/setup-node@v7 # setup Node.js
 with:
 node-version: '24.x'

Expand Down

2 changes: 1 addition & 1 deletion
.github/workflows/validate-markdown.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,7 @@ jobs:
 steps:
 - uses: actions/checkout@v7 # checkout repo content

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

Expand Down

17 changes: 12 additions & 5 deletions
CONTRIBUTING.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -179,16 +179,23 @@ Draft pull requests can still be reviewed while in draft state.
> [!NOTE]
> `npm run build-src` calls bash scripts. Use [Git Bash](https://gitforwindows.org/) on Windows, or use the Windows Subsystem for Linux (WSL).

The markdown source files are converted to HTML before publishing.
To do this locally, please
Before creating a pull request or marking a draft pull request as ready for review, validate your changes locally:

1. Install [Node.js](https://nodejs.org/)
2. Check out this repo, go to the repo root, and switch to a development branch
3. Execute `npm install` (once, repeat after merging upstream changes)
4. Execute `npm run build-src` after changing `src/oas.md` (this first executes `npm run validate-markdown`, which can also be run separately)
5. Open output file `deploy-preview/oas.html` with a browser and check your changes
4. Run the commands relevant to what you changed:

Please make sure the markdown validates and builds using the above steps before creating a pull request or marking a draft pull request as ready for review.
 | Command | What it does |
 | ------- | ------------- |
 | `npm run validate-markdown` | markdownlint + link check only — fast loop while editing |
 | `npm run format-markdown` | auto-fix markdownlint violations |
 | `npm run build-src` | full check: validation, HTML build, schema publish |
 | `npm test` | runs the JSON Schema and build tooling test suites |

5. After `npm run build-src`, open output file `deploy-preview/oas.html` with a browser and check your changes

Please make sure the markdown validates and builds, and that `npm test` passes, before creating a pull request or marking a draft pull request as ready for review.

## Reviewers

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
v3.3-dev: sync with dev by oai-spec-publisher[bot] · Pull Request #5456 · OAI/OpenAPI-Specification · GitHub
Skip to content
v3.3-dev: sync with dev#5456

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

oai-spec-publisher
merged 8 commits into

from

Jul 30, 2026
 Merged


v3.3-dev: sync with dev
#5456
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
1b3861f

Bump actions/setup-node from 6 to 7


dependabot[bot] Jul 14, 2026
8e166da

Merge pull request #5435 from OAI/dependabot/github_actions/actions/s…


ralfhandl Jul 14, 2026
bb68296

Merge main into dev-sync-with-main


github-actions[bot] Jul 14, 2026
0ee400f

Clarify local validation commands in CONTRIBUTING.md


miqui Jul 23, 2026
5423da4

Merge pull request #5443 from miqui/contributing-local-validation


handrews Jul 30, 2026
fd82831

Merge main into dev-sync-with-main


github-actions[bot] Jul 30, 2026
c2f9d6c

Merge pull request #5436 from OAI/dev-sync-with-main


miqui Jul 30, 2026
388377e

Merge dev into v3.3-dev-sync-with-dev


github-actions[bot] Jul 30, 2026

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/workflows/respec.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,7 +31,7 @@ jobs:
 with:
 fetch-depth: 0

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

Expand Down

2 changes: 1 addition & 1 deletion
.github/workflows/schema-publish.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,7 +34,7 @@ jobs:
 with:
 fetch-depth: 0

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

Expand Down

2 changes: 1 addition & 1 deletion
.github/workflows/schema-tests.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,7 +23,7 @@ jobs:
 with:
 fetch-depth: 0

 - uses: actions/setup-node@v6 # setup Node.js
 - uses: actions/setup-node@v7 # setup Node.js
 with:
 node-version: '24.x'

Expand Down

2 changes: 1 addition & 1 deletion
.github/workflows/validate-markdown.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,7 @@ jobs:
 steps:
 - uses: actions/checkout@v7 # checkout repo content

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

Expand Down

17 changes: 12 additions & 5 deletions
CONTRIBUTING.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -179,16 +179,23 @@ Draft pull requests can still be reviewed while in draft state.
> [!NOTE]
> `npm run build-src` calls bash scripts. Use [Git Bash](https://gitforwindows.org/) on Windows, or use the Windows Subsystem for Linux (WSL).

The markdown source files are converted to HTML before publishing.
To do this locally, please
Before creating a pull request or marking a draft pull request as ready for review, validate your changes locally:

1. Install [Node.js](https://nodejs.org/)
2. Check out this repo, go to the repo root, and switch to a development branch
3. Execute `npm install` (once, repeat after merging upstream changes)
4. Execute `npm run build-src` after changing `src/oas.md` (this first executes `npm run validate-markdown`, which can also be run separately)
5. Open output file `deploy-preview/oas.html` with a browser and check your changes
4. Run the commands relevant to what you changed:

Please make sure the markdown validates and builds using the above steps before creating a pull request or marking a draft pull request as ready for review.
 | Command | What it does |
 | ------- | ------------- |
 | `npm run validate-markdown` | markdownlint + link check only — fast loop while editing |
 | `npm run format-markdown` | auto-fix markdownlint violations |
 | `npm run build-src` | full check: validation, HTML build, schema publish |
 | `npm test` | runs the JSON Schema and build tooling test suites |

5. After `npm run build-src`, open output file `deploy-preview/oas.html` with a browser and check your changes

Please make sure the markdown validates and builds, and that `npm test` passes, before creating a pull request or marking a draft pull request as ready for review.

## Reviewers

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
v3.3-dev: sync with dev by oai-spec-publisher[bot] · Pull Request #5456 · OAI/OpenAPI-Specification · GitHub
Skip to content
v3.3-dev: sync with dev#5456

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

oai-spec-publisher
merged 8 commits into

from

Jul 30, 2026
 Merged


v3.3-dev: sync with dev
#5456
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
1b3861f

Bump actions/setup-node from 6 to 7


dependabot[bot] Jul 14, 2026
8e166da

Merge pull request #5435 from OAI/dependabot/github_actions/actions/s…


ralfhandl Jul 14, 2026
bb68296

Merge main into dev-sync-with-main


github-actions[bot] Jul 14, 2026
0ee400f

Clarify local validation commands in CONTRIBUTING.md


miqui Jul 23, 2026
5423da4

Merge pull request #5443 from miqui/contributing-local-validation


handrews Jul 30, 2026
fd82831

Merge main into dev-sync-with-main


github-actions[bot] Jul 30, 2026
c2f9d6c

Merge pull request #5436 from OAI/dev-sync-with-main


miqui Jul 30, 2026
388377e

Merge dev into v3.3-dev-sync-with-dev


github-actions[bot] Jul 30, 2026

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/workflows/respec.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,7 +31,7 @@ jobs:
 with:
 fetch-depth: 0

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

Expand Down

2 changes: 1 addition & 1 deletion
.github/workflows/schema-publish.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,7 +34,7 @@ jobs:
 with:
 fetch-depth: 0

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

Expand Down

2 changes: 1 addition & 1 deletion
.github/workflows/schema-tests.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,7 +23,7 @@ jobs:
 with:
 fetch-depth: 0

 - uses: actions/setup-node@v6 # setup Node.js
 - uses: actions/setup-node@v7 # setup Node.js
 with:
 node-version: '24.x'

Expand Down

2 changes: 1 addition & 1 deletion
.github/workflows/validate-markdown.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,7 @@ jobs:
 steps:
 - uses: actions/checkout@v7 # checkout repo content

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

Expand Down

17 changes: 12 additions & 5 deletions
CONTRIBUTING.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -179,16 +179,23 @@ Draft pull requests can still be reviewed while in draft state.
> [!NOTE]
> `npm run build-src` calls bash scripts. Use [Git Bash](https://gitforwindows.org/) on Windows, or use the Windows Subsystem for Linux (WSL).

The markdown source files are converted to HTML before publishing.
To do this locally, please
Before creating a pull request or marking a draft pull request as ready for review, validate your changes locally:

1. Install [Node.js](https://nodejs.org/)
2. Check out this repo, go to the repo root, and switch to a development branch
3. Execute `npm install` (once, repeat after merging upstream changes)
4. Execute `npm run build-src` after changing `src/oas.md` (this first executes `npm run validate-markdown`, which can also be run separately)
5. Open output file `deploy-preview/oas.html` with a browser and check your changes
4. Run the commands relevant to what you changed:

Please make sure the markdown validates and builds using the above steps before creating a pull request or marking a draft pull request as ready for review.
 | Command | What it does |
 | ------- | ------------- |
 | `npm run validate-markdown` | markdownlint + link check only — fast loop while editing |
 | `npm run format-markdown` | auto-fix markdownlint violations |
 | `npm run build-src` | full check: validation, HTML build, schema publish |
 | `npm test` | runs the JSON Schema and build tooling test suites |

5. After `npm run build-src`, open output file `deploy-preview/oas.html` with a browser and check your changes

Please make sure the markdown validates and builds, and that `npm test` passes, before creating a pull request or marking a draft pull request as ready for review.

## Reviewers

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
v3.3-dev: sync with dev by oai-spec-publisher[bot] · Pull Request #5456 · OAI/OpenAPI-Specification · GitHub
Skip to content
v3.3-dev: sync with dev#5456

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

oai-spec-publisher
merged 8 commits into

from

Jul 30, 2026
 Merged


v3.3-dev: sync with dev
#5456
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
1b3861f

Bump actions/setup-node from 6 to 7


dependabot[bot] Jul 14, 2026
8e166da

Merge pull request #5435 from OAI/dependabot/github_actions/actions/s…


ralfhandl Jul 14, 2026
bb68296

Merge main into dev-sync-with-main


github-actions[bot] Jul 14, 2026
0ee400f

Clarify local validation commands in CONTRIBUTING.md


miqui Jul 23, 2026
5423da4

Merge pull request #5443 from miqui/contributing-local-validation


handrews Jul 30, 2026
fd82831

Merge main into dev-sync-with-main


github-actions[bot] Jul 30, 2026
c2f9d6c

Merge pull request #5436 from OAI/dev-sync-with-main


miqui Jul 30, 2026
388377e

Merge dev into v3.3-dev-sync-with-dev


github-actions[bot] Jul 30, 2026

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/workflows/respec.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,7 +31,7 @@ jobs:
 with:
 fetch-depth: 0

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

Expand Down

2 changes: 1 addition & 1 deletion
.github/workflows/schema-publish.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,7 +34,7 @@ jobs:
 with:
 fetch-depth: 0

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

Expand Down

2 changes: 1 addition & 1 deletion
.github/workflows/schema-tests.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,7 +23,7 @@ jobs:
 with:
 fetch-depth: 0

 - uses: actions/setup-node@v6 # setup Node.js
 - uses: actions/setup-node@v7 # setup Node.js
 with:
 node-version: '24.x'

Expand Down

2 changes: 1 addition & 1 deletion
.github/workflows/validate-markdown.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,7 @@ jobs:
 steps:
 - uses: actions/checkout@v7 # checkout repo content

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

Expand Down

17 changes: 12 additions & 5 deletions
CONTRIBUTING.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -179,16 +179,23 @@ Draft pull requests can still be reviewed while in draft state.
> [!NOTE]
> `npm run build-src` calls bash scripts. Use [Git Bash](https://gitforwindows.org/) on Windows, or use the Windows Subsystem for Linux (WSL).

The markdown source files are converted to HTML before publishing.
To do this locally, please
Before creating a pull request or marking a draft pull request as ready for review, validate your changes locally:

1. Install [Node.js](https://nodejs.org/)
2. Check out this repo, go to the repo root, and switch to a development branch
3. Execute `npm install` (once, repeat after merging upstream changes)
4. Execute `npm run build-src` after changing `src/oas.md` (this first executes `npm run validate-markdown`, which can also be run separately)
5. Open output file `deploy-preview/oas.html` with a browser and check your changes
4. Run the commands relevant to what you changed:

Please make sure the markdown validates and builds using the above steps before creating a pull request or marking a draft pull request as ready for review.
 | Command | What it does |
 | ------- | ------------- |
 | `npm run validate-markdown` | markdownlint + link check only — fast loop while editing |
 | `npm run format-markdown` | auto-fix markdownlint violations |
 | `npm run build-src` | full check: validation, HTML build, schema publish |
 | `npm test` | runs the JSON Schema and build tooling test suites |

5. After `npm run build-src`, open output file `deploy-preview/oas.html` with a browser and check your changes

Please make sure the markdown validates and builds, and that `npm test` passes, before creating a pull request or marking a draft pull request as ready for review.

## Reviewers

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();
v3.3-dev: sync with dev by oai-spec-publisher[bot] · Pull Request #5456 · OAI/OpenAPI-Specification · GitHub
Skip to content
v3.3-dev: sync with dev#5456

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

oai-spec-publisher
merged 8 commits into

from

Jul 30, 2026
 Merged


v3.3-dev: sync with dev
#5456
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
1b3861f

Bump actions/setup-node from 6 to 7


dependabot[bot] Jul 14, 2026
8e166da

Merge pull request #5435 from OAI/dependabot/github_actions/actions/s…


ralfhandl Jul 14, 2026
bb68296

Merge main into dev-sync-with-main


github-actions[bot] Jul 14, 2026
0ee400f

Clarify local validation commands in CONTRIBUTING.md


miqui Jul 23, 2026
5423da4

Merge pull request #5443 from miqui/contributing-local-validation


handrews Jul 30, 2026
fd82831

Merge main into dev-sync-with-main


github-actions[bot] Jul 30, 2026
c2f9d6c

Merge pull request #5436 from OAI/dev-sync-with-main


miqui Jul 30, 2026
388377e

Merge dev into v3.3-dev-sync-with-dev


github-actions[bot] Jul 30, 2026

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/workflows/respec.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,7 +31,7 @@ jobs:
 with:
 fetch-depth: 0

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

Expand Down

2 changes: 1 addition & 1 deletion
.github/workflows/schema-publish.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,7 +34,7 @@ jobs:
 with:
 fetch-depth: 0

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

Expand Down

2 changes: 1 addition & 1 deletion
.github/workflows/schema-tests.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,7 +23,7 @@ jobs:
 with:
 fetch-depth: 0

 - uses: actions/setup-node@v6 # setup Node.js
 - uses: actions/setup-node@v7 # setup Node.js
 with:
 node-version: '24.x'

Expand Down

2 changes: 1 addition & 1 deletion
.github/workflows/validate-markdown.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,7 @@ jobs:
 steps:
 - uses: actions/checkout@v7 # checkout repo content

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

Expand Down

17 changes: 12 additions & 5 deletions
CONTRIBUTING.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -179,16 +179,23 @@ Draft pull requests can still be reviewed while in draft state.
> [!NOTE]
> `npm run build-src` calls bash scripts. Use [Git Bash](https://gitforwindows.org/) on Windows, or use the Windows Subsystem for Linux (WSL).

The markdown source files are converted to HTML before publishing.
To do this locally, please
Before creating a pull request or marking a draft pull request as ready for review, validate your changes locally:

1. Install [Node.js](https://nodejs.org/)
2. Check out this repo, go to the repo root, and switch to a development branch
3. Execute `npm install` (once, repeat after merging upstream changes)
4. Execute `npm run build-src` after changing `src/oas.md` (this first executes `npm run validate-markdown`, which can also be run separately)
5. Open output file `deploy-preview/oas.html` with a browser and check your changes
4. Run the commands relevant to what you changed:

Please make sure the markdown validates and builds using the above steps before creating a pull request or marking a draft pull request as ready for review.
 | Command | What it does |
 | ------- | ------------- |
 | `npm run validate-markdown` | markdownlint + link check only — fast loop while editing |
 | `npm run format-markdown` | auto-fix markdownlint violations |
 | `npm run build-src` | full check: validation, HTML build, schema publish |
 | `npm test` | runs the JSON Schema and build tooling test suites |

5. After `npm run build-src`, open output file `deploy-preview/oas.html` with a browser and check your changes

Please make sure the markdown validates and builds, and that `npm test` passes, before creating a pull request or marking a draft pull request as ready for review.

## Reviewers

Expand Down