chore: refresh README and add markers for auto-generated spec table#4
Conversation
- Update the endpoint table to reflect the current 14 v3 specs (was: only the 5 specs from initial seed, now stale). - Wrap the table in `<!-- SPEC_TABLE_START -->` / `<!-- SPEC_TABLE_END -->` markers so the upstream spec-sync workflow can regenerate it on each release. - Drop the reference to the upstream API repository and to a bundled spec artifact that no longer exists. - Switch the validate example to a one-liner using `npx` (no install required, matches the validate workflow). Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
PR Reviewer Guide 🔍Here are some key observations to aid the review process:
|
PR Code Suggestions ✨No code suggestions found for the PR. |
There was a problem hiding this comment.
Pull request overview
Updates the repository README to reflect the current set of v3 OpenAPI specs and to support automated regeneration of the endpoints table by adding explicit start/end markers.
Changes:
- Refreshes the README endpoints table to include all specs under
specs/v3/, and wraps the table with<!-- SPEC_TABLE_START -->/<!-- SPEC_TABLE_END -->markers for automation. - Updates usage examples to lint specs via
npx(and updates the SDK generation example to use a per-spec input file rather than a removed bundled artifact). - Revises the versioning text to remove references to an internal/upstream repository and instead point to this repo’s releases/changelog.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ```bash | ||
| npm install | ||
| npm run validate | ||
| npx --yes @stoplight/spectral-cli@^6.14.0 lint specs/v3/*.yaml |
User description
Summary
The README's endpoint table only listed 5 of the 14 v3 specs and referenced a bundled artifact (
bundled/openapi-v3.yaml) that no longer exists since #3 dropped the bundle step.This PR:
specs/v3/.<!-- SPEC_TABLE_START -->/<!-- SPEC_TABLE_END -->markers around the table so the upstream spec-sync workflow can regenerate it on every release (workflow change is a separate PR upstream).npx --yes @stoplight/spectral-cli@^6.14.0 lint specs/v3/*.yaml— matches what the CI workflow runs and doesn't need an install step.Test plan
PR Type
Documentation
Description
Refresh README endpoint table to cover all 14 v3 specs
Add auto-generation markers for spec-sync workflow
Remove references to deleted bundled spec artifact
Update validate and SDK generation examples
Diagram Walkthrough
File Walkthrough
README.md
Refresh endpoint table and remove bundled spec referencesREADME.md
specs
/markers forautomated regeneration
removed
bundled/openapi-v3.yamlnpm install && npm run validatewith a singlenpxspectrallint command
(
smileidentity/lambda)