Skip to content

chore: update v3 OpenAPI specs to v3.801.0 - #34

Merged
Ed Fricker (beastawakens) merged 1 commit into
mainfrom
sync/v3.801.0
Aug 4, 2026
Merged

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

Conversation

@beastawakens

@beastawakens Ed Fricker (beastawakens) commented Aug 4, 2026

Copy link
Copy Markdown
Member

User description

Automated v3 OpenAPI spec update for v3.801.0.

Triggered by Ed Fricker (@beastawakens) - assigned to you in case it needs a manual merge.


PR Type

Documentation, Enhancement


Description

  • Replay callback body now multipart/form-data

  • Added 415 Unsupported Media Type response

  • Reworded error messages from "verification" to "job"

  • Changelog entry added for v3.801.0


Diagram Walkthrough

flowchart LR
  A["Replay callback endpoint"] -- "request body" --> B["application/json → multipart/form-data"]
  A -- "new response" --> C["415 Unsupported Media Type"]
  A -- "error messages" --> D["'verification' → 'job' wording"]
  E["CHANGELOG.md"] -- "release notes" --> F["v3.801.0 entry"]
Loading

File Walkthrough

Relevant files
Documentation
openapi.yaml
Replay callback switched to multipart with 415 response   

specs/v3/openapi.yaml

  • Changed replay callback request body content type from
    application/json to multipart/form-data
  • Added note that other content types are rejected with 415
  • Added 415 Unsupported Media Type response with example
  • Updated 400/404/409 example messages to reference "job" instead of
    "verification"
+18/-7   
v3-replay-callback.yaml
Update replay callback spec content type and errors           

specs/v3/v3-replay-callback.yaml

  • Mirrored bundled spec changes: request body now multipart/form-data
  • Added 415 Unsupported Media Type response definition and example
  • Reworded error example messages to use "job" terminology
+20/-6   
CHANGELOG.md
Add v3.801.0 changelog entry                                                         

CHANGELOG.md

  • Added v3.801.0 release section dated 2026-08-04
  • Listed updates to openapi and v3-replay-callback
+7/-0     


Need help?
  • Type /help how to ... in the comments thread for any questions about PR-Agent usage.
  • Check out the documentation for more information.
  • @prfectionist

    prfectionist Bot commented Aug 4, 2026

    Copy link
    Copy Markdown

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

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

    Breaking API Change

    The replay-callback request body content type is switched from application/json to
    multipart/form-data exclusively, and any other content type is now documented as rejected with 415.
    Existing integrations that POST a JSON body (e.g. {"callback_url": "..."}) will start failing.
    If backward compatibility is expected, the spec should list both application/json and
    multipart/form-data; otherwise the changelog entry should explicitly mark this as a breaking change
    rather than a generic "Updated openapi".

      Send the body as `multipart/form-data`. Any other content type is rejected with 415.
    content:
      multipart/form-data:
        schema:
          $ref: '#/components/schemas/ReplayCallbackRequest'
    Schema/Media Type Mismatch

    ReplayCallbackRequest is referenced under multipart/form-data without any encoding section.
    For multipart bodies, generators/validators typically need per-property encoding (e.g.
    contentType: text/plain for scalar fields) to produce correct clients; nested or non-scalar
    properties in the schema will serialize ambiguously. Consider adding an explicit encoding block or
    confirming the schema contains only flat scalar fields.

    content:
      multipart/form-data:
        schema:
          $ref: '#/components/schemas/ReplayCallbackRequest'
        example:
          callback_url: 'https://partner.example.com/webhook'

    @beastawakens
    Ed Fricker (beastawakens) merged commit fe4fe0e into main Aug 4, 2026
    2 checks passed
    @beastawakens
    Ed Fricker (beastawakens) deleted the sync/v3.801.0 branch August 4, 2026 15:28
    @prfectionist

    prfectionist Bot commented Aug 4, 2026

    Copy link
    Copy Markdown

    PR Code Suggestions ✨

    No code suggestions found for the PR.

    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.

    1 participant