Skip to content

chore: refresh README and add markers for auto-generated spec table#4

Merged
Ed Fricker (beastawakens) merged 1 commit into
mainfrom
chore/readme-refresh
May 8, 2026
Merged

chore: refresh README and add markers for auto-generated spec table#4
Ed Fricker (beastawakens) merged 1 commit into
mainfrom
chore/readme-refresh

Conversation

@beastawakens
Copy link
Copy Markdown
Member

@beastawakens Ed Fricker (beastawakens) commented May 8, 2026

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:

  • Refreshes the endpoint table to reflect all 14 specs currently in specs/v3/.
  • Adds <!-- 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).
  • Removes the reference to the upstream API repository (we don't want to advertise internal repo names from this public-facing README).
  • Switches the validate example to 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.
  • Drops the SDK-generation example pointing at the dead bundled spec; uses one of the per-API specs instead.

Test plan

  • CI passes on this PR (no spec changes, so validate is a no-op gate)
  • After merge, next sync run will pick up the markers and regenerate the table in-place

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

flowchart LR
  A["README.md"] -- "update" --> B["Endpoint table (5 → 14 specs)"]
  A -- "add" --> C["SPEC_TABLE markers"]
  A -- "remove" --> D["Bundled spec references"]
  A -- "update" --> E["CLI examples"]
Loading

File Walkthrough

Relevant files
Documentation
README.md
Refresh endpoint table and remove bundled spec references

README.md

  • Expanded endpoint table from 5 to 14 entries covering all current v3
    specs
  • Added / markers for
    automated regeneration
  • Replaced SDK generation example to use individual spec file instead of
    removed bundled/openapi-v3.yaml
  • Replaced npm install && npm run validate with a single npx spectral
    lint command
  • Removed reference to internal upstream API repository
    (smileidentity/lambda)
  • Simplified versioning section
+23/-12 


Need help?
  • Type /help how to ... in the comments thread for any questions about PR-Agent usage.
  • Check out the documentation for more information.
  • - 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>
    Copilot AI review requested due to automatic review settings May 8, 2026 11:27
    @prfectionist
    Copy link
    Copy Markdown

    prfectionist Bot commented May 8, 2026

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

    🎫 Ticket compliance analysis 🔶

    3 - Partially compliant

    Compliant requirements:

    • Remove references to the bundled spec artifact (the README no longer points to bundled/openapi-v3.yaml)

    Non-compliant requirements:

    Requires further human verification:

    • CI passes on this PR
    ⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
    🏅 Score: 90
    🧪 No relevant tests
    🔒 No security concerns identified
    🔀 No multiple PR themes
    ⚡ Recommended focus areas for review

    Duplicate Entry

    The [Services](specs/v3/v3-services.yaml) spec appears twice in the table with different endpoints (/v3/services/bank_codes and /v3/services/supported_id_types). If the auto-generation workflow regenerates this table, it should be verified that this duplication is intentional and won't cause confusion — typically a single spec file would have one row linking to it, with multiple endpoints described within the spec itself.

    | [Services](specs/v3/v3-services.yaml) | `GET /v3/services/bank_codes` | List bank codes |
    | [Services](specs/v3/v3-services.yaml) | `GET /v3/services/supported_id_types` | List supported KYC ID types |

    @prfectionist
    Copy link
    Copy Markdown

    prfectionist Bot commented May 8, 2026

    PR Code Suggestions ✨

    No code suggestions found for the PR.

    Copy link
    Copy Markdown

    Copilot AI left a comment

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    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.

    Comment thread README.md
    ```bash
    npm install
    npm run validate
    npx --yes @stoplight/spectral-cli@^6.14.0 lint specs/v3/*.yaml
    @beastawakens Ed Fricker (beastawakens) merged commit a46071a into main May 8, 2026
    5 checks passed
    @beastawakens Ed Fricker (beastawakens) deleted the chore/readme-refresh branch May 8, 2026 11:34
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

    Projects

    None yet

    Development

    Successfully merging this pull request may close these issues.

    2 participants