Skip to content

chore: update v3 OpenAPI specs to v3.553.0#7

Merged
Ed Fricker (beastawakens) merged 1 commit into
mainfrom
sync/v3.553.0
May 8, 2026
Merged

chore: update v3 OpenAPI specs to v3.553.0#7
Ed Fricker (beastawakens) merged 1 commit into
mainfrom
sync/v3.553.0

Conversation

@beastawakens
Copy link
Copy Markdown
Member

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

User description

Automated v3 OpenAPI spec update for v3.553.0.


PR Type

Enhancement


Description

  • Consolidate separate API specs into unified v3-services.yaml

  • Remove standalone v3-id-status, v3-supported-documents specs

  • Rename v3-enhanced-kyc-job-status to v3-verification-status

  • Update docs, README table, and changelog accordingly


Diagram Walkthrough

flowchart LR
  A["v3-id-status.yaml (removed)"] -- "merged into" --> B["v3-services.yaml"]
  C["v3-supported-documents.yaml (removed)"] -- "merged into" --> B
  D["v3-enhanced-kyc-job-status.yaml"] -- "renamed to" --> E["v3-verification-status.yaml"]
Loading

File Walkthrough

Relevant files
Documentation
3 files
CHANGELOG.md
Add v3.553.0 changelog entry with removals                             
+11/-0   
README.md
Update spec table to reflect consolidation                             
+3/-3     
index.html
Update SPECS list removing deleted entries                             
+2/-4     
Enhancement
4 files
v3-id-status.yaml
Remove standalone ID status spec file                                       
+0/-140 
v3-services.yaml
Add id_status and supported_documents endpoints                   
+284/-4 
v3-supported-documents.yaml
Remove standalone supported documents spec file                   
+0/-187 
v3-verification-status.yaml
Rename operationId to getVerificationStatus                           
+1/-1     


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

    prfectionist Bot commented May 8, 2026

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

    ⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪
    🏅 Score: 85
    🧪 No relevant tests
    🔒 No security concerns identified
    🔀 No multiple PR themes
    ⚡ Recommended focus areas for review

    Missing Blank Line

    The ## [Unreleased] header on line 7 is immediately followed by ## [v3.553.0] on line 8 without a blank line separating them. This makes the [Unreleased] section appear empty and visually merged with the next version entry, which deviates from the Keep a Changelog format where [Unreleased] should have its own distinct section.

    ## [Unreleased]
    ## [v3.553.0] - 2026-05-08
    Inconsistent Changelog

    The changelog lists v3-enhanced-kyc-job-status under "Removed" but the PR actually renames it to v3-verification-status. The "Changed" section mentions "Updated v3-verification-status" but doesn't clarify it was renamed from the old spec. This could confuse consumers tracking breaking changes.

    ### Removed
    - `v3-enhanced-kyc-job-status`
    - `v3-id-status`
    - `v3-supported-documents`

    @prfectionist
    Copy link
    Copy Markdown

    prfectionist Bot commented May 8, 2026

    PR Code Suggestions ✨

    No code suggestions found for the PR.

    @beastawakens Ed Fricker (beastawakens) merged commit 4788b35 into main May 8, 2026
    4 checks passed
    @beastawakens Ed Fricker (beastawakens) deleted the sync/v3.553.0 branch May 8, 2026 17:12
    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

    Automated sync of the v3 OpenAPI spec set to v3.553.0, consolidating “services” endpoints into v3-services.yaml and renaming the verification status operation for /v3/status/{jobId}.

    Changes:

    • Renamed the /v3/status/{jobId} operationId to getVerificationStatus and updated docs links accordingly.
    • Merged Supported Documents and ID Status specs into v3-services.yaml, removing the standalone spec files.
    • Updated the docs site spec list and changelog to reflect the consolidated/removed specs.

    Reviewed changes

    Copilot reviewed 7 out of 7 changed files in this pull request and generated no comments.

    Show a summary per file
    File Description
    specs/v3/v3-verification-status.yaml Renames the operationId for the verification status endpoint.
    specs/v3/v3-supported-documents.yaml Removes standalone supported-documents spec (now covered by v3-services).
    specs/v3/v3-services.yaml Adds supported-documents + id-status endpoints/schemas and auth scheme to Services spec.
    specs/v3/v3-id-status.yaml Removes standalone id-status spec (now covered by v3-services).
    README.md Updates the endpoint/spec table to point at consolidated specs and new “Verification Status” entry.
    docs/index.html Updates Redoc spec selector list to remove deleted specs and include verification status.
    CHANGELOG.md Adds v3.553.0 entry documenting updated/removed specs.

    💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

    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