feat(spec): cover 158 live gateway capabilities missing from openapi.yaml #73
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| [ | ||
| { | ||
| "name": "internal", | ||
| "justification": "Live skill has pricing.model=free and auth.scope=null — an operator-only utility route by the gateway's own metadata (no scope to grant, nothing to meter), not a customer-facing capability. Documenting it as a public operation would misrepresent it as purchasable." | ||
| } | ||
| ] |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,102 @@ | ||
| #!/usr/bin/env node | ||
| /** | ||
| * skills-index-coverage.mjs — fail if a live, priced gateway capability has no operation in | ||
| * openapi.yaml. | ||
| * | ||
| * WHY THIS EXISTS: docs are GENERATED from openapi.yaml, but the gateway's live capability | ||
| * index (https://gateway.wave.online/.well-known/wave-skills.json) is the actual source of | ||
| * truth for what customers can call and pay for. The two can drift — a capability ships at | ||
| * the gateway before anyone documents it here. This gate catches that drift going forward: | ||
| * every name in the live index must resolve to a documented product in the spec (a matching | ||
| * top-level path segment or tag), or be named — with a reason — in the allowlist next to | ||
| * this script. | ||
| * | ||
| * Matching is deliberately coarse (product-level, not per-operation): the skills index itself | ||
| * is flat (one entry per product, e.g. `/v1/render`), while the spec documents richer nested | ||
| * shapes for the same product (`/render`, `/render/{jobId}`, `/render/{jobId}/events`). A skill | ||
| * named `foo` is "covered" if the spec has a path whose first segment is `foo` OR a tag whose | ||
| * name normalizes to `foo` (case/space/hyphen-insensitive). | ||
| * | ||
| * Usage: node .github/scripts/skills-index-coverage.mjs openapi.yaml | ||
| * Exit 0 = every live capability is covered or allowlisted. | ||
| * Exit 1 = at least one live, non-allowlisted capability has no matching operation. | ||
| * Exit 2 = could not read/parse the spec, or the live index could not be fetched. | ||
| * | ||
| * Network: fetches ONLY the well-known skills index URL below (GET, unauthenticated, public). | ||
| */ | ||
| import { readFileSync } from 'node:fs'; | ||
| import { fileURLToPath } from 'node:url'; | ||
| import { dirname, join } from 'node:path'; | ||
|
|
||
| const SKILLS_INDEX_URL = 'https://gateway.wave.online/.well-known/wave-skills.json'; | ||
| const __dirname = dirname(fileURLToPath(import.meta.url)); | ||
| const ALLOWLIST_PATH = join(__dirname, 'skills-index-allowlist.json'); | ||
|
|
||
| const specPath = process.argv[2]; | ||
| if (!specPath) { | ||
| console.error('usage: skills-index-coverage.mjs <openapi.yaml>'); | ||
| process.exit(2); | ||
| } | ||
|
|
||
| function norm(name) { | ||
| return String(name).replace(/[-_ ]/g, '').toLowerCase(); | ||
| } | ||
|
|
||
| let doc; | ||
| try { | ||
| const raw = readFileSync(specPath, 'utf8'); | ||
| const yaml = await import('js-yaml'); | ||
| doc = (yaml.default ?? yaml).load(raw); | ||
| } catch (err) { | ||
| console.error(`could not read/parse ${specPath}: ${err.message}`); | ||
| process.exit(2); | ||
| } | ||
|
|
||
| let allowlist = []; | ||
| try { | ||
| allowlist = JSON.parse(readFileSync(ALLOWLIST_PATH, 'utf8')); | ||
| } catch (err) { | ||
| console.error(`could not read/parse ${ALLOWLIST_PATH}: ${err.message}`); | ||
| process.exit(2); | ||
| } | ||
| const allowSet = new Set(allowlist.map((e) => norm(e.name))); | ||
| for (const e of allowlist) { | ||
| if (!e.name || !e.justification) { | ||
| console.error(`allowlist entry missing name/justification: ${JSON.stringify(e)}`); | ||
| process.exit(2); | ||
| } | ||
| } | ||
|
|
||
| const covered = new Set(); | ||
| for (const p of Object.keys(doc.paths ?? {})) { | ||
| const seg = p.split('/').filter(Boolean)[0]; | ||
| if (seg && !seg.startsWith('{')) covered.add(norm(seg)); | ||
| } | ||
| for (const t of doc.tags ?? []) { | ||
| if (t.name) covered.add(norm(t.name)); | ||
| } | ||
|
|
||
| let skills; | ||
| try { | ||
| const res = await fetch(SKILLS_INDEX_URL); | ||
| if (!res.ok) throw new Error(`HTTP ${res.status}`); | ||
| skills = await res.json(); | ||
| } catch (err) { | ||
| console.error(`could not fetch ${SKILLS_INDEX_URL}: ${err.message}`); | ||
| process.exit(2); | ||
| } | ||
|
|
||
| const missing = []; | ||
| for (const s of skills) { | ||
| const key = norm(s.name); | ||
|
Comment on lines
+90
to
+91
There was a problem hiding this comment. 🩺 Stability & Availability | 🟡 Minor | ⚡ Quick win 🔎 Supported by static analysis🏁 Script executed: #!/usr/bin/env bash
set -euo pipefail
payload="$(curl -fsS --max-time 20 \
https://gateway.wave.online/.well-known/wave-skills.json)"
jq -e '
type == "array" and
all(.[]; type == "object" and (.name | type == "string") and (.name | length > 0))
' <<<"$payload"Repository: wave-av/api-spec Length of output: 159 🏁 Script executed: #!/usr/bin/env bash
set -euo pipefail
printf '%s\n' '--- repository conventions ---'
find /tmp/coderabbit-repo-knowledge/wave-av-api-spec-136a5465 -mindepth 2 -maxdepth 2 -type f -name '*.md' -print \
-exec sh -c 'echo "--- $1"; cat "$1"' sh {} \;
printf '%s\n' '--- target script ---'
cat -n .github/scripts/skills-index-coverage.mjs | sed -n '1,130p'
printf '%s\n' '--- relevant diff ---'
git diff --unified=20 1f0cb94f4a06085a594ad52269ffcb1c9dc25f83 252781ac0e20881bcccfedc604c095b0a955c661 -- .github/scripts/skills-index-coverage.mjsRepository: wave-av/api-spec Length of output: 10248 🏁 Script executed: #!/usr/bin/env bash
set -euo pipefail
cat -n .github/scripts/skills-index-coverage.mjs | sed -n '1,130p'Repository: wave-av/api-spec Length of output: 4746 Validate the live index shape before iterating. If 🤖 Prompt for AI AgentsSource: Linters/SAST tools |
||
| if (covered.has(key)) continue; | ||
| if (allowSet.has(key)) continue; | ||
|
Comment on lines
+79
to
+93
There was a problem hiding this comment.
|
||
| missing.push(s.name); | ||
| } | ||
|
|
||
| console.log(`skills-index-coverage: ${skills.length - missing.length}/${skills.length} live capabilities covered (${allowlist.length} allowlisted)`); | ||
| if (missing.length) { | ||
| console.error(`::error::${missing.length} live priced capabilities have no matching operation/tag in ${specPath}: ${missing.join(', ')}`); | ||
| process.exit(1); | ||
| } | ||
| console.log('skills-index-coverage: OK'); | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
💡 Edge Case: No timeout on skills-index fetch() in CI gate
fetch(SKILLS_INDEX_URL) at .github/scripts/skills-index-coverage.mjs:81 has no AbortController/timeout, so if gateway.wave.online is slow or hangs, the job blocks until the workflow's 10-minute timeout-minutes in foundation-gate.yml kills it, burning the full CI budget on every PR instead of failing fast with a clear timeout error. Add a short fetch timeout (e.g. AbortSignal.timeout(15000)) so a slow/unreachable dependency fails quickly with an actionable message.
Bound the network call so a hung gateway fails fast instead of consuming the full job timeout.:
Check the box to apply the fix or reply for a change | Was this helpful? React with 👍 / 👎