Skip to content

v3.2-dev: update from dev#4685

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
ralfhandl merged 5 commits into from
Jun 11, 2025
+69 −68
Merged

v3.2-dev: update from dev #4685

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
7ebc858
Update the schema test coverage tool to use an EvaluationPlugin
jdesrosiers Jun 10, 2025
1a88e1b
Bump @hyperjump/json-schema from 1.15.0 to 1.15.1
dependabot[bot] Jun 11, 2025
af020b6
Merge pull request #4681 from jdesrosiers/update-schema-coverage-tool
ralfhandl Jun 11, 2025
0f9f16e
Merge pull request #4682 from OAI/dependabot/npm_and_yarn/hyperjump/j…
ralfhandl Jun 11, 2025
ec901cf
Merge pull request #4683 from OAI/main
ralfhandl Jun 11, 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
8 changes: 4 additions & 4 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,7 @@
"yargs": "^18.0.0"
},
"devDependencies": {
"@hyperjump/json-schema": "^1.15.0",
"@hyperjump/json-schema": "^1.15.1",
"c8": "^10.1.3",
"markdownlint-cli2": "^0.18.1",
"vitest": "^3.2.3",
Expand Down
127 changes: 64 additions & 63 deletions scripts/schema-test-coverage.mjs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,20 +2,13 @@ import { readdir, readFile } from "node:fs/promises";
import YAML from "yaml";
import { join } from "node:path";
import { argv } from "node:process";
import "@hyperjump/json-schema/draft-2020-12";
import { validate } from "@hyperjump/json-schema/draft-2020-12";
import "@hyperjump/json-schema/draft-04";
import {
compile,
getSchema,
interpret,
Validation,
BASIC,
} from "@hyperjump/json-schema/experimental";
import * as Instance from "@hyperjump/json-schema/instance/experimental";
import { BASIC } from "@hyperjump/json-schema/experimental";

/**
* @import { AST } from "@hyperjump/json-schema/experimental"
* @import { Json } from "@hyperjump/json-schema"
* @import { EvaluationPlugin } from "@hyperjump/json-schema/experimental"
* @import { Json } from "@hyperjump/json-pointer"
*/

import contentTypeParser from "content-type";
Expand All@@ -36,6 +29,41 @@ addMediaTypePlugin("application/schema+yaml", {
fileMatcher: (path) => path.endsWith(".yaml"),
});

/** @implements EvaluationPlugin */
class TestCoveragePlugin {
constructor() {
/** @type Set<string> */
this.visitedLocations = new Set();
}

beforeSchema(_schemaUri, _instance, context) {
if (this.allLocations) {
return;
}

/** @type Set<string> */
this.allLocations = [];

for (const schemaLocation in context.ast) {
if (schemaLocation === "metaData") {
continue;
}

if (Array.isArray(context.ast[schemaLocation])) {
for (const keyword of context.ast[schemaLocation]) {
if (Array.isArray(keyword)) {
this.allLocations.push(keyword[1]);
}
}
}
}
}

beforeKeyword([, schemaUri]) {
this.visitedLocations.add(schemaUri);
}
}

/** @type (testDirectory: string) => AsyncGenerator<[string,Json]> */
const tests = async function* (testDirectory) {
for (const file of await readdir(testDirectory, {
Expand All@@ -53,70 +81,43 @@ const tests = async function* (testDirectory) {
}
};

/** @type (testDirectory: string) => Promise<void> */
const runTests = async (testDirectory) => {
for await (const [name, test] of tests(testDirectory)) {
const instance = Instance.fromJs(test);
/**
* @typedef {{
* allLocations: string[];
* visitedLocations: Set<string>;
* }} Coverage
*/

const result = interpret(compiled, instance, BASIC);
/** @type (schemaUri: string, testDirectory: string) => Promise<Coverage> */
const runTests = async (schemaUri, testDirectory) => {
const testCoveragePlugin = new TestCoveragePlugin();
const validateOpenApi = await validate(schemaUri);

for await (const [name, test] of tests(testDirectory)) {
const result = validateOpenApi(test, {
outputFormat: BASIC,
plugins: [testCoveragePlugin],
});

if (!result.valid) {
console.log("Failed:", name, result.errors);
}
}
};

/** @type (ast: AST) => string[] */
const keywordLocations = (ast) => {
/** @type string[] */
const locations = [];
for (const schemaLocation in ast) {
if (schemaLocation === "metaData") {
continue;
}

if (Array.isArray(ast[schemaLocation])) {
for (const keyword of ast[schemaLocation]) {
if (Array.isArray(keyword)) {
locations.push(keyword[1]);
}
}
}
}

return locations;
return {
allLocations: testCoveragePlugin.allLocations ?? new Set(),
visitedLocations: testCoveragePlugin.visitedLocations
};
};

///////////////////////////////////////////////////////////////////////////////

const schema = await getSchema(argv[2]);
const compiled = await compile(schema);

/** @type Set<string> */
const visitedLocations = new Set();
const baseInterpret = Validation.interpret;
Validation.interpret = (url, instance, context) => {
if (Array.isArray(context.ast[url])) {
for (const keywordNode of context.ast[url]) {
if (Array.isArray(keywordNode)) {
visitedLocations.add(keywordNode[1]);
}
}
}
return baseInterpret(url, instance, context);
};

await runTests(argv[3]);
Validation.interpret = baseInterpret;

// console.log("Covered:", visitedLocations);

const allKeywords = keywordLocations(compiled.ast);
const notCovered = allKeywords.filter(
const { allLocations, visitedLocations } = await runTests(argv[2], argv[3]);
const notCovered = allLocations.filter(
(location) => !visitedLocations.has(location),
);
if (notCovered.length > 0) {
console.log("NOT Covered:", notCovered.length, "of", allKeywords.length);
console.log("NOT Covered:", notCovered.length, "of", allLocations.length);
const maxNotCovered = 20;
const firstNotCovered = notCovered.slice(0, maxNotCovered);
if (notCovered.length > maxNotCovered) firstNotCovered.push("...");
Expand All@@ -127,6 +128,6 @@ console.log(
"Covered:",
visitedLocations.size,
"of",
allKeywords.length,
"(" + Math.floor((visitedLocations.size / allKeywords.length) * 100) + "%)",
allLocations.length,
"(" + Math.floor((visitedLocations.size / allLocations.length) * 100) + "%)",
);
, '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.2-dev: update from dev by github-actions[bot] · Pull Request #4685 · OAI/OpenAPI-Specification · GitHub
Skip to content
v3.2-dev: update from dev#4685

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

ralfhandl
merged 5 commits into

from

Jun 11, 2025

+69

−68

 Merged


v3.2-dev: update from dev
#4685
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
7ebc858

Update the schema test coverage tool to use an EvaluationPlugin


jdesrosiers Jun 10, 2025
1a88e1b

Bump @hyperjump/json-schema from 1.15.0 to 1.15.1


dependabot[bot] Jun 11, 2025
af020b6

Merge pull request #4681 from jdesrosiers/update-schema-coverage-tool


ralfhandl Jun 11, 2025
0f9f16e

Merge pull request #4682 from OAI/dependabot/npm_and_yarn/hyperjump/j…


ralfhandl Jun 11, 2025
ec901cf

Merge pull request #4683 from OAI/main


ralfhandl Jun 11, 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


8 changes: 4 additions & 4 deletions
package-lock.json

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.


2 changes: 1 addition & 1 deletion
package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,7 @@
 "yargs": "^18.0.0"
 },
 "devDependencies": {
 "@hyperjump/json-schema": "^1.15.0",
 "@hyperjump/json-schema": "^1.15.1",
 "c8": "^10.1.3",
 "markdownlint-cli2": "^0.18.1",
 "vitest": "^3.2.3",
Expand Down

127 changes: 64 additions & 63 deletions
scripts/schema-test-coverage.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,20 +2,13 @@ import { readdir, readFile } from "node:fs/promises";
import YAML from "yaml";
import { join } from "node:path";
import { argv } from "node:process";
import "@hyperjump/json-schema/draft-2020-12";
import { validate } from "@hyperjump/json-schema/draft-2020-12";
import "@hyperjump/json-schema/draft-04";
import {
 compile,
 getSchema,
 interpret,
 Validation,
 BASIC,
} from "@hyperjump/json-schema/experimental";
import * as Instance from "@hyperjump/json-schema/instance/experimental";
import { BASIC } from "@hyperjump/json-schema/experimental";

/**
 * @import { AST } from "@hyperjump/json-schema/experimental"
 * @import { Json } from "@hyperjump/json-schema"
 * @import { EvaluationPlugin } from "@hyperjump/json-schema/experimental"
 * @import { Json } from "@hyperjump/json-pointer"
 */

import contentTypeParser from "content-type";
Expand All@@ -36,6 +29,41 @@ addMediaTypePlugin("application/schema+yaml", {
 fileMatcher: (path) => path.endsWith(".yaml"),
});

/** @implements EvaluationPlugin */
class TestCoveragePlugin {
 constructor() {
 /** @type Set<string> */
 this.visitedLocations = new Set();
 }

 beforeSchema(_schemaUri, _instance, context) {
 if (this.allLocations) {
 return;
 }

 /** @type Set<string> */
 this.allLocations = [];

 for (const schemaLocation in context.ast) {
 if (schemaLocation === "metaData") {
 continue;
 }

 if (Array.isArray(context.ast[schemaLocation])) {
 for (const keyword of context.ast[schemaLocation]) {
 if (Array.isArray(keyword)) {
 this.allLocations.push(keyword[1]);
 }
 }
 }
 }
 }

 beforeKeyword([, schemaUri]) {
 this.visitedLocations.add(schemaUri);
 }
}

/** @type (testDirectory: string) => AsyncGenerator<[string,Json]> */
const tests = async function* (testDirectory) {
 for (const file of await readdir(testDirectory, {
Expand All@@ -53,70 +81,43 @@ const tests = async function* (testDirectory) {
 }
};

/** @type (testDirectory: string) => Promise<void> */
const runTests = async (testDirectory) => {
 for await (const [name, test] of tests(testDirectory)) {
 const instance = Instance.fromJs(test);
/**
 * @typedef {{
 * allLocations: string[];
 * visitedLocations: Set<string>;
 * }} Coverage
 */

 const result = interpret(compiled, instance, BASIC);
/** @type (schemaUri: string, testDirectory: string) => Promise<Coverage> */
const runTests = async (schemaUri, testDirectory) => {
 const testCoveragePlugin = new TestCoveragePlugin();
 const validateOpenApi = await validate(schemaUri);

 for await (const [name, test] of tests(testDirectory)) {
 const result = validateOpenApi(test, {
 outputFormat: BASIC,
 plugins: [testCoveragePlugin],
 });

 if (!result.valid) {
 console.log("Failed:", name, result.errors);
 }
 }
};

/** @type (ast: AST) => string[] */
const keywordLocations = (ast) => {
 /** @type string[] */
 const locations = [];
 for (const schemaLocation in ast) {
 if (schemaLocation === "metaData") {
 continue;
 }

 if (Array.isArray(ast[schemaLocation])) {
 for (const keyword of ast[schemaLocation]) {
 if (Array.isArray(keyword)) {
 locations.push(keyword[1]);
 }
 }
 }
 }

 return locations;
 return {
 allLocations: testCoveragePlugin.allLocations ?? new Set(),
 visitedLocations: testCoveragePlugin.visitedLocations
 };
};

///////////////////////////////////////////////////////////////////////////////

const schema = await getSchema(argv[2]);
const compiled = await compile(schema);

/** @type Set<string> */
const visitedLocations = new Set();
const baseInterpret = Validation.interpret;
Validation.interpret = (url, instance, context) => {
 if (Array.isArray(context.ast[url])) {
 for (const keywordNode of context.ast[url]) {
 if (Array.isArray(keywordNode)) {
 visitedLocations.add(keywordNode[1]);
 }
 }
 }
 return baseInterpret(url, instance, context);
};

await runTests(argv[3]);
Validation.interpret = baseInterpret;

// console.log("Covered:", visitedLocations);

const allKeywords = keywordLocations(compiled.ast);
const notCovered = allKeywords.filter(
const { allLocations, visitedLocations } = await runTests(argv[2], argv[3]);
const notCovered = allLocations.filter(
 (location) => !visitedLocations.has(location),
);
if (notCovered.length > 0) {
 console.log("NOT Covered:", notCovered.length, "of", allKeywords.length);
 console.log("NOT Covered:", notCovered.length, "of", allLocations.length);
 const maxNotCovered = 20;
 const firstNotCovered = notCovered.slice(0, maxNotCovered);
 if (notCovered.length > maxNotCovered) firstNotCovered.push("...");
Expand All@@ -127,6 +128,6 @@ console.log(
 "Covered:",
 visitedLocations.size,
 "of",
allKeywords.length,
 "(" + Math.floor((visitedLocations.size / allKeywords.length) * 100) + "%)",
allLocations.length,
 "(" + Math.floor((visitedLocations.size / allLocations.length) * 100) + "%)",
);

, '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.2-dev: update from dev by github-actions[bot] · Pull Request #4685 · OAI/OpenAPI-Specification · GitHub
Skip to content
v3.2-dev: update from dev#4685

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

ralfhandl
merged 5 commits into

from

Jun 11, 2025

+69

−68

 Merged


v3.2-dev: update from dev
#4685
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
7ebc858

Update the schema test coverage tool to use an EvaluationPlugin


jdesrosiers Jun 10, 2025
1a88e1b

Bump @hyperjump/json-schema from 1.15.0 to 1.15.1


dependabot[bot] Jun 11, 2025
af020b6

Merge pull request #4681 from jdesrosiers/update-schema-coverage-tool


ralfhandl Jun 11, 2025
0f9f16e

Merge pull request #4682 from OAI/dependabot/npm_and_yarn/hyperjump/j…


ralfhandl Jun 11, 2025
ec901cf

Merge pull request #4683 from OAI/main


ralfhandl Jun 11, 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


8 changes: 4 additions & 4 deletions
package-lock.json

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.


2 changes: 1 addition & 1 deletion
package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,7 @@
 "yargs": "^18.0.0"
 },
 "devDependencies": {
 "@hyperjump/json-schema": "^1.15.0",
 "@hyperjump/json-schema": "^1.15.1",
 "c8": "^10.1.3",
 "markdownlint-cli2": "^0.18.1",
 "vitest": "^3.2.3",
Expand Down

127 changes: 64 additions & 63 deletions
scripts/schema-test-coverage.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,20 +2,13 @@ import { readdir, readFile } from "node:fs/promises";
import YAML from "yaml";
import { join } from "node:path";
import { argv } from "node:process";
import "@hyperjump/json-schema/draft-2020-12";
import { validate } from "@hyperjump/json-schema/draft-2020-12";
import "@hyperjump/json-schema/draft-04";
import {
 compile,
 getSchema,
 interpret,
 Validation,
 BASIC,
} from "@hyperjump/json-schema/experimental";
import * as Instance from "@hyperjump/json-schema/instance/experimental";
import { BASIC } from "@hyperjump/json-schema/experimental";

/**
 * @import { AST } from "@hyperjump/json-schema/experimental"
 * @import { Json } from "@hyperjump/json-schema"
 * @import { EvaluationPlugin } from "@hyperjump/json-schema/experimental"
 * @import { Json } from "@hyperjump/json-pointer"
 */

import contentTypeParser from "content-type";
Expand All@@ -36,6 +29,41 @@ addMediaTypePlugin("application/schema+yaml", {
 fileMatcher: (path) => path.endsWith(".yaml"),
});

/** @implements EvaluationPlugin */
class TestCoveragePlugin {
 constructor() {
 /** @type Set<string> */
 this.visitedLocations = new Set();
 }

 beforeSchema(_schemaUri, _instance, context) {
 if (this.allLocations) {
 return;
 }

 /** @type Set<string> */
 this.allLocations = [];

 for (const schemaLocation in context.ast) {
 if (schemaLocation === "metaData") {
 continue;
 }

 if (Array.isArray(context.ast[schemaLocation])) {
 for (const keyword of context.ast[schemaLocation]) {
 if (Array.isArray(keyword)) {
 this.allLocations.push(keyword[1]);
 }
 }
 }
 }
 }

 beforeKeyword([, schemaUri]) {
 this.visitedLocations.add(schemaUri);
 }
}

/** @type (testDirectory: string) => AsyncGenerator<[string,Json]> */
const tests = async function* (testDirectory) {
 for (const file of await readdir(testDirectory, {
Expand All@@ -53,70 +81,43 @@ const tests = async function* (testDirectory) {
 }
};

/** @type (testDirectory: string) => Promise<void> */
const runTests = async (testDirectory) => {
 for await (const [name, test] of tests(testDirectory)) {
 const instance = Instance.fromJs(test);
/**
 * @typedef {{
 * allLocations: string[];
 * visitedLocations: Set<string>;
 * }} Coverage
 */

 const result = interpret(compiled, instance, BASIC);
/** @type (schemaUri: string, testDirectory: string) => Promise<Coverage> */
const runTests = async (schemaUri, testDirectory) => {
 const testCoveragePlugin = new TestCoveragePlugin();
 const validateOpenApi = await validate(schemaUri);

 for await (const [name, test] of tests(testDirectory)) {
 const result = validateOpenApi(test, {
 outputFormat: BASIC,
 plugins: [testCoveragePlugin],
 });

 if (!result.valid) {
 console.log("Failed:", name, result.errors);
 }
 }
};

/** @type (ast: AST) => string[] */
const keywordLocations = (ast) => {
 /** @type string[] */
 const locations = [];
 for (const schemaLocation in ast) {
 if (schemaLocation === "metaData") {
 continue;
 }

 if (Array.isArray(ast[schemaLocation])) {
 for (const keyword of ast[schemaLocation]) {
 if (Array.isArray(keyword)) {
 locations.push(keyword[1]);
 }
 }
 }
 }

 return locations;
 return {
 allLocations: testCoveragePlugin.allLocations ?? new Set(),
 visitedLocations: testCoveragePlugin.visitedLocations
 };
};

///////////////////////////////////////////////////////////////////////////////

const schema = await getSchema(argv[2]);
const compiled = await compile(schema);

/** @type Set<string> */
const visitedLocations = new Set();
const baseInterpret = Validation.interpret;
Validation.interpret = (url, instance, context) => {
 if (Array.isArray(context.ast[url])) {
 for (const keywordNode of context.ast[url]) {
 if (Array.isArray(keywordNode)) {
 visitedLocations.add(keywordNode[1]);
 }
 }
 }
 return baseInterpret(url, instance, context);
};

await runTests(argv[3]);
Validation.interpret = baseInterpret;

// console.log("Covered:", visitedLocations);

const allKeywords = keywordLocations(compiled.ast);
const notCovered = allKeywords.filter(
const { allLocations, visitedLocations } = await runTests(argv[2], argv[3]);
const notCovered = allLocations.filter(
 (location) => !visitedLocations.has(location),
);
if (notCovered.length > 0) {
 console.log("NOT Covered:", notCovered.length, "of", allKeywords.length);
 console.log("NOT Covered:", notCovered.length, "of", allLocations.length);
 const maxNotCovered = 20;
 const firstNotCovered = notCovered.slice(0, maxNotCovered);
 if (notCovered.length > maxNotCovered) firstNotCovered.push("...");
Expand All@@ -127,6 +128,6 @@ console.log(
 "Covered:",
 visitedLocations.size,
 "of",
allKeywords.length,
 "(" + Math.floor((visitedLocations.size / allKeywords.length) * 100) + "%)",
allLocations.length,
 "(" + Math.floor((visitedLocations.size / allLocations.length) * 100) + "%)",
);

, '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.2-dev: update from dev by github-actions[bot] · Pull Request #4685 · OAI/OpenAPI-Specification · GitHub
Skip to content
v3.2-dev: update from dev#4685

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

ralfhandl
merged 5 commits into

from

Jun 11, 2025

+69

−68

 Merged


v3.2-dev: update from dev
#4685
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
7ebc858

Update the schema test coverage tool to use an EvaluationPlugin


jdesrosiers Jun 10, 2025
1a88e1b

Bump @hyperjump/json-schema from 1.15.0 to 1.15.1


dependabot[bot] Jun 11, 2025
af020b6

Merge pull request #4681 from jdesrosiers/update-schema-coverage-tool


ralfhandl Jun 11, 2025
0f9f16e

Merge pull request #4682 from OAI/dependabot/npm_and_yarn/hyperjump/j…


ralfhandl Jun 11, 2025
ec901cf

Merge pull request #4683 from OAI/main


ralfhandl Jun 11, 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


8 changes: 4 additions & 4 deletions
package-lock.json

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.


2 changes: 1 addition & 1 deletion
package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,7 @@
 "yargs": "^18.0.0"
 },
 "devDependencies": {
 "@hyperjump/json-schema": "^1.15.0",
 "@hyperjump/json-schema": "^1.15.1",
 "c8": "^10.1.3",
 "markdownlint-cli2": "^0.18.1",
 "vitest": "^3.2.3",
Expand Down

127 changes: 64 additions & 63 deletions
scripts/schema-test-coverage.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,20 +2,13 @@ import { readdir, readFile } from "node:fs/promises";
import YAML from "yaml";
import { join } from "node:path";
import { argv } from "node:process";
import "@hyperjump/json-schema/draft-2020-12";
import { validate } from "@hyperjump/json-schema/draft-2020-12";
import "@hyperjump/json-schema/draft-04";
import {
 compile,
 getSchema,
 interpret,
 Validation,
 BASIC,
} from "@hyperjump/json-schema/experimental";
import * as Instance from "@hyperjump/json-schema/instance/experimental";
import { BASIC } from "@hyperjump/json-schema/experimental";

/**
 * @import { AST } from "@hyperjump/json-schema/experimental"
 * @import { Json } from "@hyperjump/json-schema"
 * @import { EvaluationPlugin } from "@hyperjump/json-schema/experimental"
 * @import { Json } from "@hyperjump/json-pointer"
 */

import contentTypeParser from "content-type";
Expand All@@ -36,6 +29,41 @@ addMediaTypePlugin("application/schema+yaml", {
 fileMatcher: (path) => path.endsWith(".yaml"),
});

/** @implements EvaluationPlugin */
class TestCoveragePlugin {
 constructor() {
 /** @type Set<string> */
 this.visitedLocations = new Set();
 }

 beforeSchema(_schemaUri, _instance, context) {
 if (this.allLocations) {
 return;
 }

 /** @type Set<string> */
 this.allLocations = [];

 for (const schemaLocation in context.ast) {
 if (schemaLocation === "metaData") {
 continue;
 }

 if (Array.isArray(context.ast[schemaLocation])) {
 for (const keyword of context.ast[schemaLocation]) {
 if (Array.isArray(keyword)) {
 this.allLocations.push(keyword[1]);
 }
 }
 }
 }
 }

 beforeKeyword([, schemaUri]) {
 this.visitedLocations.add(schemaUri);
 }
}

/** @type (testDirectory: string) => AsyncGenerator<[string,Json]> */
const tests = async function* (testDirectory) {
 for (const file of await readdir(testDirectory, {
Expand All@@ -53,70 +81,43 @@ const tests = async function* (testDirectory) {
 }
};

/** @type (testDirectory: string) => Promise<void> */
const runTests = async (testDirectory) => {
 for await (const [name, test] of tests(testDirectory)) {
 const instance = Instance.fromJs(test);
/**
 * @typedef {{
 * allLocations: string[];
 * visitedLocations: Set<string>;
 * }} Coverage
 */

 const result = interpret(compiled, instance, BASIC);
/** @type (schemaUri: string, testDirectory: string) => Promise<Coverage> */
const runTests = async (schemaUri, testDirectory) => {
 const testCoveragePlugin = new TestCoveragePlugin();
 const validateOpenApi = await validate(schemaUri);

 for await (const [name, test] of tests(testDirectory)) {
 const result = validateOpenApi(test, {
 outputFormat: BASIC,
 plugins: [testCoveragePlugin],
 });

 if (!result.valid) {
 console.log("Failed:", name, result.errors);
 }
 }
};

/** @type (ast: AST) => string[] */
const keywordLocations = (ast) => {
 /** @type string[] */
 const locations = [];
 for (const schemaLocation in ast) {
 if (schemaLocation === "metaData") {
 continue;
 }

 if (Array.isArray(ast[schemaLocation])) {
 for (const keyword of ast[schemaLocation]) {
 if (Array.isArray(keyword)) {
 locations.push(keyword[1]);
 }
 }
 }
 }

 return locations;
 return {
 allLocations: testCoveragePlugin.allLocations ?? new Set(),
 visitedLocations: testCoveragePlugin.visitedLocations
 };
};

///////////////////////////////////////////////////////////////////////////////

const schema = await getSchema(argv[2]);
const compiled = await compile(schema);

/** @type Set<string> */
const visitedLocations = new Set();
const baseInterpret = Validation.interpret;
Validation.interpret = (url, instance, context) => {
 if (Array.isArray(context.ast[url])) {
 for (const keywordNode of context.ast[url]) {
 if (Array.isArray(keywordNode)) {
 visitedLocations.add(keywordNode[1]);
 }
 }
 }
 return baseInterpret(url, instance, context);
};

await runTests(argv[3]);
Validation.interpret = baseInterpret;

// console.log("Covered:", visitedLocations);

const allKeywords = keywordLocations(compiled.ast);
const notCovered = allKeywords.filter(
const { allLocations, visitedLocations } = await runTests(argv[2], argv[3]);
const notCovered = allLocations.filter(
 (location) => !visitedLocations.has(location),
);
if (notCovered.length > 0) {
 console.log("NOT Covered:", notCovered.length, "of", allKeywords.length);
 console.log("NOT Covered:", notCovered.length, "of", allLocations.length);
 const maxNotCovered = 20;
 const firstNotCovered = notCovered.slice(0, maxNotCovered);
 if (notCovered.length > maxNotCovered) firstNotCovered.push("...");
Expand All@@ -127,6 +128,6 @@ console.log(
 "Covered:",
 visitedLocations.size,
 "of",
allKeywords.length,
 "(" + Math.floor((visitedLocations.size / allKeywords.length) * 100) + "%)",
allLocations.length,
 "(" + Math.floor((visitedLocations.size / allLocations.length) * 100) + "%)",
);

, '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.2-dev: update from dev by github-actions[bot] · Pull Request #4685 · OAI/OpenAPI-Specification · GitHub
Skip to content
v3.2-dev: update from dev#4685

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

ralfhandl
merged 5 commits into

from

Jun 11, 2025

+69

−68

 Merged


v3.2-dev: update from dev
#4685
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
7ebc858

Update the schema test coverage tool to use an EvaluationPlugin


jdesrosiers Jun 10, 2025
1a88e1b

Bump @hyperjump/json-schema from 1.15.0 to 1.15.1


dependabot[bot] Jun 11, 2025
af020b6

Merge pull request #4681 from jdesrosiers/update-schema-coverage-tool


ralfhandl Jun 11, 2025
0f9f16e

Merge pull request #4682 from OAI/dependabot/npm_and_yarn/hyperjump/j…


ralfhandl Jun 11, 2025
ec901cf

Merge pull request #4683 from OAI/main


ralfhandl Jun 11, 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


8 changes: 4 additions & 4 deletions
package-lock.json

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.


2 changes: 1 addition & 1 deletion
package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,7 @@
 "yargs": "^18.0.0"
 },
 "devDependencies": {
 "@hyperjump/json-schema": "^1.15.0",
 "@hyperjump/json-schema": "^1.15.1",
 "c8": "^10.1.3",
 "markdownlint-cli2": "^0.18.1",
 "vitest": "^3.2.3",
Expand Down

127 changes: 64 additions & 63 deletions
scripts/schema-test-coverage.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,20 +2,13 @@ import { readdir, readFile } from "node:fs/promises";
import YAML from "yaml";
import { join } from "node:path";
import { argv } from "node:process";
import "@hyperjump/json-schema/draft-2020-12";
import { validate } from "@hyperjump/json-schema/draft-2020-12";
import "@hyperjump/json-schema/draft-04";
import {
 compile,
 getSchema,
 interpret,
 Validation,
 BASIC,
} from "@hyperjump/json-schema/experimental";
import * as Instance from "@hyperjump/json-schema/instance/experimental";
import { BASIC } from "@hyperjump/json-schema/experimental";

/**
 * @import { AST } from "@hyperjump/json-schema/experimental"
 * @import { Json } from "@hyperjump/json-schema"
 * @import { EvaluationPlugin } from "@hyperjump/json-schema/experimental"
 * @import { Json } from "@hyperjump/json-pointer"
 */

import contentTypeParser from "content-type";
Expand All@@ -36,6 +29,41 @@ addMediaTypePlugin("application/schema+yaml", {
 fileMatcher: (path) => path.endsWith(".yaml"),
});

/** @implements EvaluationPlugin */
class TestCoveragePlugin {
 constructor() {
 /** @type Set<string> */
 this.visitedLocations = new Set();
 }

 beforeSchema(_schemaUri, _instance, context) {
 if (this.allLocations) {
 return;
 }

 /** @type Set<string> */
 this.allLocations = [];

 for (const schemaLocation in context.ast) {
 if (schemaLocation === "metaData") {
 continue;
 }

 if (Array.isArray(context.ast[schemaLocation])) {
 for (const keyword of context.ast[schemaLocation]) {
 if (Array.isArray(keyword)) {
 this.allLocations.push(keyword[1]);
 }
 }
 }
 }
 }

 beforeKeyword([, schemaUri]) {
 this.visitedLocations.add(schemaUri);
 }
}

/** @type (testDirectory: string) => AsyncGenerator<[string,Json]> */
const tests = async function* (testDirectory) {
 for (const file of await readdir(testDirectory, {
Expand All@@ -53,70 +81,43 @@ const tests = async function* (testDirectory) {
 }
};

/** @type (testDirectory: string) => Promise<void> */
const runTests = async (testDirectory) => {
 for await (const [name, test] of tests(testDirectory)) {
 const instance = Instance.fromJs(test);
/**
 * @typedef {{
 * allLocations: string[];
 * visitedLocations: Set<string>;
 * }} Coverage
 */

 const result = interpret(compiled, instance, BASIC);
/** @type (schemaUri: string, testDirectory: string) => Promise<Coverage> */
const runTests = async (schemaUri, testDirectory) => {
 const testCoveragePlugin = new TestCoveragePlugin();
 const validateOpenApi = await validate(schemaUri);

 for await (const [name, test] of tests(testDirectory)) {
 const result = validateOpenApi(test, {
 outputFormat: BASIC,
 plugins: [testCoveragePlugin],
 });

 if (!result.valid) {
 console.log("Failed:", name, result.errors);
 }
 }
};

/** @type (ast: AST) => string[] */
const keywordLocations = (ast) => {
 /** @type string[] */
 const locations = [];
 for (const schemaLocation in ast) {
 if (schemaLocation === "metaData") {
 continue;
 }

 if (Array.isArray(ast[schemaLocation])) {
 for (const keyword of ast[schemaLocation]) {
 if (Array.isArray(keyword)) {
 locations.push(keyword[1]);
 }
 }
 }
 }

 return locations;
 return {
 allLocations: testCoveragePlugin.allLocations ?? new Set(),
 visitedLocations: testCoveragePlugin.visitedLocations
 };
};

///////////////////////////////////////////////////////////////////////////////

const schema = await getSchema(argv[2]);
const compiled = await compile(schema);

/** @type Set<string> */
const visitedLocations = new Set();
const baseInterpret = Validation.interpret;
Validation.interpret = (url, instance, context) => {
 if (Array.isArray(context.ast[url])) {
 for (const keywordNode of context.ast[url]) {
 if (Array.isArray(keywordNode)) {
 visitedLocations.add(keywordNode[1]);
 }
 }
 }
 return baseInterpret(url, instance, context);
};

await runTests(argv[3]);
Validation.interpret = baseInterpret;

// console.log("Covered:", visitedLocations);

const allKeywords = keywordLocations(compiled.ast);
const notCovered = allKeywords.filter(
const { allLocations, visitedLocations } = await runTests(argv[2], argv[3]);
const notCovered = allLocations.filter(
 (location) => !visitedLocations.has(location),
);
if (notCovered.length > 0) {
 console.log("NOT Covered:", notCovered.length, "of", allKeywords.length);
 console.log("NOT Covered:", notCovered.length, "of", allLocations.length);
 const maxNotCovered = 20;
 const firstNotCovered = notCovered.slice(0, maxNotCovered);
 if (notCovered.length > maxNotCovered) firstNotCovered.push("...");
Expand All@@ -127,6 +128,6 @@ console.log(
 "Covered:",
 visitedLocations.size,
 "of",
allKeywords.length,
 "(" + Math.floor((visitedLocations.size / allKeywords.length) * 100) + "%)",
allLocations.length,
 "(" + Math.floor((visitedLocations.size / allLocations.length) * 100) + "%)",
);

, '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.2-dev: update from dev by github-actions[bot] · Pull Request #4685 · OAI/OpenAPI-Specification · GitHub
Skip to content
v3.2-dev: update from dev#4685

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

ralfhandl
merged 5 commits into

from

Jun 11, 2025

+69

−68

 Merged


v3.2-dev: update from dev
#4685
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
7ebc858

Update the schema test coverage tool to use an EvaluationPlugin


jdesrosiers Jun 10, 2025
1a88e1b

Bump @hyperjump/json-schema from 1.15.0 to 1.15.1


dependabot[bot] Jun 11, 2025
af020b6

Merge pull request #4681 from jdesrosiers/update-schema-coverage-tool


ralfhandl Jun 11, 2025
0f9f16e

Merge pull request #4682 from OAI/dependabot/npm_and_yarn/hyperjump/j…


ralfhandl Jun 11, 2025
ec901cf

Merge pull request #4683 from OAI/main


ralfhandl Jun 11, 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


8 changes: 4 additions & 4 deletions
package-lock.json

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.


2 changes: 1 addition & 1 deletion
package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,7 @@
 "yargs": "^18.0.0"
 },
 "devDependencies": {
 "@hyperjump/json-schema": "^1.15.0",
 "@hyperjump/json-schema": "^1.15.1",
 "c8": "^10.1.3",
 "markdownlint-cli2": "^0.18.1",
 "vitest": "^3.2.3",
Expand Down

127 changes: 64 additions & 63 deletions
scripts/schema-test-coverage.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,20 +2,13 @@ import { readdir, readFile } from "node:fs/promises";
import YAML from "yaml";
import { join } from "node:path";
import { argv } from "node:process";
import "@hyperjump/json-schema/draft-2020-12";
import { validate } from "@hyperjump/json-schema/draft-2020-12";
import "@hyperjump/json-schema/draft-04";
import {
 compile,
 getSchema,
 interpret,
 Validation,
 BASIC,
} from "@hyperjump/json-schema/experimental";
import * as Instance from "@hyperjump/json-schema/instance/experimental";
import { BASIC } from "@hyperjump/json-schema/experimental";

/**
 * @import { AST } from "@hyperjump/json-schema/experimental"
 * @import { Json } from "@hyperjump/json-schema"
 * @import { EvaluationPlugin } from "@hyperjump/json-schema/experimental"
 * @import { Json } from "@hyperjump/json-pointer"
 */

import contentTypeParser from "content-type";
Expand All@@ -36,6 +29,41 @@ addMediaTypePlugin("application/schema+yaml", {
 fileMatcher: (path) => path.endsWith(".yaml"),
});

/** @implements EvaluationPlugin */
class TestCoveragePlugin {
 constructor() {
 /** @type Set<string> */
 this.visitedLocations = new Set();
 }

 beforeSchema(_schemaUri, _instance, context) {
 if (this.allLocations) {
 return;
 }

 /** @type Set<string> */
 this.allLocations = [];

 for (const schemaLocation in context.ast) {
 if (schemaLocation === "metaData") {
 continue;
 }

 if (Array.isArray(context.ast[schemaLocation])) {
 for (const keyword of context.ast[schemaLocation]) {
 if (Array.isArray(keyword)) {
 this.allLocations.push(keyword[1]);
 }
 }
 }
 }
 }

 beforeKeyword([, schemaUri]) {
 this.visitedLocations.add(schemaUri);
 }
}

/** @type (testDirectory: string) => AsyncGenerator<[string,Json]> */
const tests = async function* (testDirectory) {
 for (const file of await readdir(testDirectory, {
Expand All@@ -53,70 +81,43 @@ const tests = async function* (testDirectory) {
 }
};

/** @type (testDirectory: string) => Promise<void> */
const runTests = async (testDirectory) => {
 for await (const [name, test] of tests(testDirectory)) {
 const instance = Instance.fromJs(test);
/**
 * @typedef {{
 * allLocations: string[];
 * visitedLocations: Set<string>;
 * }} Coverage
 */

 const result = interpret(compiled, instance, BASIC);
/** @type (schemaUri: string, testDirectory: string) => Promise<Coverage> */
const runTests = async (schemaUri, testDirectory) => {
 const testCoveragePlugin = new TestCoveragePlugin();
 const validateOpenApi = await validate(schemaUri);

 for await (const [name, test] of tests(testDirectory)) {
 const result = validateOpenApi(test, {
 outputFormat: BASIC,
 plugins: [testCoveragePlugin],
 });

 if (!result.valid) {
 console.log("Failed:", name, result.errors);
 }
 }
};

/** @type (ast: AST) => string[] */
const keywordLocations = (ast) => {
 /** @type string[] */
 const locations = [];
 for (const schemaLocation in ast) {
 if (schemaLocation === "metaData") {
 continue;
 }

 if (Array.isArray(ast[schemaLocation])) {
 for (const keyword of ast[schemaLocation]) {
 if (Array.isArray(keyword)) {
 locations.push(keyword[1]);
 }
 }
 }
 }

 return locations;
 return {
 allLocations: testCoveragePlugin.allLocations ?? new Set(),
 visitedLocations: testCoveragePlugin.visitedLocations
 };
};

///////////////////////////////////////////////////////////////////////////////

const schema = await getSchema(argv[2]);
const compiled = await compile(schema);

/** @type Set<string> */
const visitedLocations = new Set();
const baseInterpret = Validation.interpret;
Validation.interpret = (url, instance, context) => {
 if (Array.isArray(context.ast[url])) {
 for (const keywordNode of context.ast[url]) {
 if (Array.isArray(keywordNode)) {
 visitedLocations.add(keywordNode[1]);
 }
 }
 }
 return baseInterpret(url, instance, context);
};

await runTests(argv[3]);
Validation.interpret = baseInterpret;

// console.log("Covered:", visitedLocations);

const allKeywords = keywordLocations(compiled.ast);
const notCovered = allKeywords.filter(
const { allLocations, visitedLocations } = await runTests(argv[2], argv[3]);
const notCovered = allLocations.filter(
 (location) => !visitedLocations.has(location),
);
if (notCovered.length > 0) {
 console.log("NOT Covered:", notCovered.length, "of", allKeywords.length);
 console.log("NOT Covered:", notCovered.length, "of", allLocations.length);
 const maxNotCovered = 20;
 const firstNotCovered = notCovered.slice(0, maxNotCovered);
 if (notCovered.length > maxNotCovered) firstNotCovered.push("...");
Expand All@@ -127,6 +128,6 @@ console.log(
 "Covered:",
 visitedLocations.size,
 "of",
allKeywords.length,
 "(" + Math.floor((visitedLocations.size / allKeywords.length) * 100) + "%)",
allLocations.length,
 "(" + Math.floor((visitedLocations.size / allLocations.length) * 100) + "%)",
);

, '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.2-dev: update from dev by github-actions[bot] · Pull Request #4685 · OAI/OpenAPI-Specification · GitHub
Skip to content
v3.2-dev: update from dev#4685

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

ralfhandl
merged 5 commits into

from

Jun 11, 2025

+69

−68

 Merged


v3.2-dev: update from dev
#4685
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
7ebc858

Update the schema test coverage tool to use an EvaluationPlugin


jdesrosiers Jun 10, 2025
1a88e1b

Bump @hyperjump/json-schema from 1.15.0 to 1.15.1


dependabot[bot] Jun 11, 2025
af020b6

Merge pull request #4681 from jdesrosiers/update-schema-coverage-tool


ralfhandl Jun 11, 2025
0f9f16e

Merge pull request #4682 from OAI/dependabot/npm_and_yarn/hyperjump/j…


ralfhandl Jun 11, 2025
ec901cf

Merge pull request #4683 from OAI/main


ralfhandl Jun 11, 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


8 changes: 4 additions & 4 deletions
package-lock.json

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.


2 changes: 1 addition & 1 deletion
package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,7 @@
 "yargs": "^18.0.0"
 },
 "devDependencies": {
 "@hyperjump/json-schema": "^1.15.0",
 "@hyperjump/json-schema": "^1.15.1",
 "c8": "^10.1.3",
 "markdownlint-cli2": "^0.18.1",
 "vitest": "^3.2.3",
Expand Down

127 changes: 64 additions & 63 deletions
scripts/schema-test-coverage.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,20 +2,13 @@ import { readdir, readFile } from "node:fs/promises";
import YAML from "yaml";
import { join } from "node:path";
import { argv } from "node:process";
import "@hyperjump/json-schema/draft-2020-12";
import { validate } from "@hyperjump/json-schema/draft-2020-12";
import "@hyperjump/json-schema/draft-04";
import {
 compile,
 getSchema,
 interpret,
 Validation,
 BASIC,
} from "@hyperjump/json-schema/experimental";
import * as Instance from "@hyperjump/json-schema/instance/experimental";
import { BASIC } from "@hyperjump/json-schema/experimental";

/**
 * @import { AST } from "@hyperjump/json-schema/experimental"
 * @import { Json } from "@hyperjump/json-schema"
 * @import { EvaluationPlugin } from "@hyperjump/json-schema/experimental"
 * @import { Json } from "@hyperjump/json-pointer"
 */

import contentTypeParser from "content-type";
Expand All@@ -36,6 +29,41 @@ addMediaTypePlugin("application/schema+yaml", {
 fileMatcher: (path) => path.endsWith(".yaml"),
});

/** @implements EvaluationPlugin */
class TestCoveragePlugin {
 constructor() {
 /** @type Set<string> */
 this.visitedLocations = new Set();
 }

 beforeSchema(_schemaUri, _instance, context) {
 if (this.allLocations) {
 return;
 }

 /** @type Set<string> */
 this.allLocations = [];

 for (const schemaLocation in context.ast) {
 if (schemaLocation === "metaData") {
 continue;
 }

 if (Array.isArray(context.ast[schemaLocation])) {
 for (const keyword of context.ast[schemaLocation]) {
 if (Array.isArray(keyword)) {
 this.allLocations.push(keyword[1]);
 }
 }
 }
 }
 }

 beforeKeyword([, schemaUri]) {
 this.visitedLocations.add(schemaUri);
 }
}

/** @type (testDirectory: string) => AsyncGenerator<[string,Json]> */
const tests = async function* (testDirectory) {
 for (const file of await readdir(testDirectory, {
Expand All@@ -53,70 +81,43 @@ const tests = async function* (testDirectory) {
 }
};

/** @type (testDirectory: string) => Promise<void> */
const runTests = async (testDirectory) => {
 for await (const [name, test] of tests(testDirectory)) {
 const instance = Instance.fromJs(test);
/**
 * @typedef {{
 * allLocations: string[];
 * visitedLocations: Set<string>;
 * }} Coverage
 */

 const result = interpret(compiled, instance, BASIC);
/** @type (schemaUri: string, testDirectory: string) => Promise<Coverage> */
const runTests = async (schemaUri, testDirectory) => {
 const testCoveragePlugin = new TestCoveragePlugin();
 const validateOpenApi = await validate(schemaUri);

 for await (const [name, test] of tests(testDirectory)) {
 const result = validateOpenApi(test, {
 outputFormat: BASIC,
 plugins: [testCoveragePlugin],
 });

 if (!result.valid) {
 console.log("Failed:", name, result.errors);
 }
 }
};

/** @type (ast: AST) => string[] */
const keywordLocations = (ast) => {
 /** @type string[] */
 const locations = [];
 for (const schemaLocation in ast) {
 if (schemaLocation === "metaData") {
 continue;
 }

 if (Array.isArray(ast[schemaLocation])) {
 for (const keyword of ast[schemaLocation]) {
 if (Array.isArray(keyword)) {
 locations.push(keyword[1]);
 }
 }
 }
 }

 return locations;
 return {
 allLocations: testCoveragePlugin.allLocations ?? new Set(),
 visitedLocations: testCoveragePlugin.visitedLocations
 };
};

///////////////////////////////////////////////////////////////////////////////

const schema = await getSchema(argv[2]);
const compiled = await compile(schema);

/** @type Set<string> */
const visitedLocations = new Set();
const baseInterpret = Validation.interpret;
Validation.interpret = (url, instance, context) => {
 if (Array.isArray(context.ast[url])) {
 for (const keywordNode of context.ast[url]) {
 if (Array.isArray(keywordNode)) {
 visitedLocations.add(keywordNode[1]);
 }
 }
 }
 return baseInterpret(url, instance, context);
};

await runTests(argv[3]);
Validation.interpret = baseInterpret;

// console.log("Covered:", visitedLocations);

const allKeywords = keywordLocations(compiled.ast);
const notCovered = allKeywords.filter(
const { allLocations, visitedLocations } = await runTests(argv[2], argv[3]);
const notCovered = allLocations.filter(
 (location) => !visitedLocations.has(location),
);
if (notCovered.length > 0) {
 console.log("NOT Covered:", notCovered.length, "of", allKeywords.length);
 console.log("NOT Covered:", notCovered.length, "of", allLocations.length);
 const maxNotCovered = 20;
 const firstNotCovered = notCovered.slice(0, maxNotCovered);
 if (notCovered.length > maxNotCovered) firstNotCovered.push("...");
Expand All@@ -127,6 +128,6 @@ console.log(
 "Covered:",
 visitedLocations.size,
 "of",
allKeywords.length,
 "(" + Math.floor((visitedLocations.size / allKeywords.length) * 100) + "%)",
allLocations.length,
 "(" + Math.floor((visitedLocations.size / allLocations.length) * 100) + "%)",
);

, '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.2-dev: update from dev by github-actions[bot] · Pull Request #4685 · OAI/OpenAPI-Specification · GitHub
Skip to content
v3.2-dev: update from dev#4685

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

ralfhandl
merged 5 commits into

from

Jun 11, 2025

+69

−68

 Merged


v3.2-dev: update from dev
#4685
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
7ebc858

Update the schema test coverage tool to use an EvaluationPlugin


jdesrosiers Jun 10, 2025
1a88e1b

Bump @hyperjump/json-schema from 1.15.0 to 1.15.1


dependabot[bot] Jun 11, 2025
af020b6

Merge pull request #4681 from jdesrosiers/update-schema-coverage-tool


ralfhandl Jun 11, 2025
0f9f16e

Merge pull request #4682 from OAI/dependabot/npm_and_yarn/hyperjump/j…


ralfhandl Jun 11, 2025
ec901cf

Merge pull request #4683 from OAI/main


ralfhandl Jun 11, 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


8 changes: 4 additions & 4 deletions
package-lock.json

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.


2 changes: 1 addition & 1 deletion
package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,7 @@
 "yargs": "^18.0.0"
 },
 "devDependencies": {
 "@hyperjump/json-schema": "^1.15.0",
 "@hyperjump/json-schema": "^1.15.1",
 "c8": "^10.1.3",
 "markdownlint-cli2": "^0.18.1",
 "vitest": "^3.2.3",
Expand Down

127 changes: 64 additions & 63 deletions
scripts/schema-test-coverage.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,20 +2,13 @@ import { readdir, readFile } from "node:fs/promises";
import YAML from "yaml";
import { join } from "node:path";
import { argv } from "node:process";
import "@hyperjump/json-schema/draft-2020-12";
import { validate } from "@hyperjump/json-schema/draft-2020-12";
import "@hyperjump/json-schema/draft-04";
import {
 compile,
 getSchema,
 interpret,
 Validation,
 BASIC,
} from "@hyperjump/json-schema/experimental";
import * as Instance from "@hyperjump/json-schema/instance/experimental";
import { BASIC } from "@hyperjump/json-schema/experimental";

/**
 * @import { AST } from "@hyperjump/json-schema/experimental"
 * @import { Json } from "@hyperjump/json-schema"
 * @import { EvaluationPlugin } from "@hyperjump/json-schema/experimental"
 * @import { Json } from "@hyperjump/json-pointer"
 */

import contentTypeParser from "content-type";
Expand All@@ -36,6 +29,41 @@ addMediaTypePlugin("application/schema+yaml", {
 fileMatcher: (path) => path.endsWith(".yaml"),
});

/** @implements EvaluationPlugin */
class TestCoveragePlugin {
 constructor() {
 /** @type Set<string> */
 this.visitedLocations = new Set();
 }

 beforeSchema(_schemaUri, _instance, context) {
 if (this.allLocations) {
 return;
 }

 /** @type Set<string> */
 this.allLocations = [];

 for (const schemaLocation in context.ast) {
 if (schemaLocation === "metaData") {
 continue;
 }

 if (Array.isArray(context.ast[schemaLocation])) {
 for (const keyword of context.ast[schemaLocation]) {
 if (Array.isArray(keyword)) {
 this.allLocations.push(keyword[1]);
 }
 }
 }
 }
 }

 beforeKeyword([, schemaUri]) {
 this.visitedLocations.add(schemaUri);
 }
}

/** @type (testDirectory: string) => AsyncGenerator<[string,Json]> */
const tests = async function* (testDirectory) {
 for (const file of await readdir(testDirectory, {
Expand All@@ -53,70 +81,43 @@ const tests = async function* (testDirectory) {
 }
};

/** @type (testDirectory: string) => Promise<void> */
const runTests = async (testDirectory) => {
 for await (const [name, test] of tests(testDirectory)) {
 const instance = Instance.fromJs(test);
/**
 * @typedef {{
 * allLocations: string[];
 * visitedLocations: Set<string>;
 * }} Coverage
 */

 const result = interpret(compiled, instance, BASIC);
/** @type (schemaUri: string, testDirectory: string) => Promise<Coverage> */
const runTests = async (schemaUri, testDirectory) => {
 const testCoveragePlugin = new TestCoveragePlugin();
 const validateOpenApi = await validate(schemaUri);

 for await (const [name, test] of tests(testDirectory)) {
 const result = validateOpenApi(test, {
 outputFormat: BASIC,
 plugins: [testCoveragePlugin],
 });

 if (!result.valid) {
 console.log("Failed:", name, result.errors);
 }
 }
};

/** @type (ast: AST) => string[] */
const keywordLocations = (ast) => {
 /** @type string[] */
 const locations = [];
 for (const schemaLocation in ast) {
 if (schemaLocation === "metaData") {
 continue;
 }

 if (Array.isArray(ast[schemaLocation])) {
 for (const keyword of ast[schemaLocation]) {
 if (Array.isArray(keyword)) {
 locations.push(keyword[1]);
 }
 }
 }
 }

 return locations;
 return {
 allLocations: testCoveragePlugin.allLocations ?? new Set(),
 visitedLocations: testCoveragePlugin.visitedLocations
 };
};

///////////////////////////////////////////////////////////////////////////////

const schema = await getSchema(argv[2]);
const compiled = await compile(schema);

/** @type Set<string> */
const visitedLocations = new Set();
const baseInterpret = Validation.interpret;
Validation.interpret = (url, instance, context) => {
 if (Array.isArray(context.ast[url])) {
 for (const keywordNode of context.ast[url]) {
 if (Array.isArray(keywordNode)) {
 visitedLocations.add(keywordNode[1]);
 }
 }
 }
 return baseInterpret(url, instance, context);
};

await runTests(argv[3]);
Validation.interpret = baseInterpret;

// console.log("Covered:", visitedLocations);

const allKeywords = keywordLocations(compiled.ast);
const notCovered = allKeywords.filter(
const { allLocations, visitedLocations } = await runTests(argv[2], argv[3]);
const notCovered = allLocations.filter(
 (location) => !visitedLocations.has(location),
);
if (notCovered.length > 0) {
 console.log("NOT Covered:", notCovered.length, "of", allKeywords.length);
 console.log("NOT Covered:", notCovered.length, "of", allLocations.length);
 const maxNotCovered = 20;
 const firstNotCovered = notCovered.slice(0, maxNotCovered);
 if (notCovered.length > maxNotCovered) firstNotCovered.push("...");
Expand All@@ -127,6 +128,6 @@ console.log(
 "Covered:",
 visitedLocations.size,
 "of",
allKeywords.length,
 "(" + Math.floor((visitedLocations.size / allKeywords.length) * 100) + "%)",
allLocations.length,
 "(" + Math.floor((visitedLocations.size / allLocations.length) * 100) + "%)",
);