Skip to content

4. Pro action, after #214 (changelog@pr-comment-lists-changes) - #102

Open
oasdiff-test wants to merge 1 commit into
mainfrom
demo/pro-pr214
Open

oasdiff-test wants to merge 1 commit into
mainfrom
demo/pro-pr214

Conversation

@oasdiff-test

Copy link
Copy Markdown
Owner

Demo PR for comparing the oasdiff PR comment before and after oasdiff-action#214. Not for merging.

Runs oasdiff/oasdiff-action/changelog@pr-comment-lists-changes, with an oasdiff-token (Pro), as the only oasdiff workflow on the branch, so the comment below is the one that action posted and nothing else.

The spec edit breaks clients four ways (a removed success response, a property that became required, a narrowed property type, a parameter that became required) and adds three optional properties and a version bump, so there is a mixed severity set for the comment to order. breaking reports the 3 at WARN and above; changelog reports all 11.

Four endpoint and schema edits that break clients, plus three added
optional properties and a version bump, so the comment has a mixed
severity set to order.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@github-actions

github-actions Bot commented Nov 15, 2026 •

Copy link
Copy Markdown

📋 11 API changes in this pull request

⏳ Review required: approve every change to make the oasdiff status check pass.

severity change endpoint
error the data/name request property type changed from string to integer request-property-type-changed POST /api/v1.0/groups
error the data/name response's property type changed from string to integer for status 400 response-property-type-changed POST /api/v1.0/groups
error removed the success response with the status 200 response-success-status-removed POST /api/v1.0/groups
info the API version changed from 3.0 to 3.1 api-version-changed info
info added the new optional request property data/label new-optional-request-property POST /api/v1.0/groups
6 more
severity change endpoint
info added the new optional request property data/owner new-optional-request-property POST /api/v1.0/groups
info added the new optional request property data/tier new-optional-request-property POST /api/v1.0/groups
info added the optional property data/label to the response with the 400 status response-optional-property-added POST /api/v1.0/groups
info added the optional property data/owner to the response with the 400 status response-optional-property-added POST /api/v1.0/groups
info added the optional property data/tier to the response with the 400 status response-optional-property-added POST /api/v1.0/groups
info the response property data/id became required for the status 400 response-property-became-required POST /api/v1.0/groups

Review and approve the changes

🔒 The comparison is encrypted in CI before it's uploaded. The decryption key stays in this link's fragment (after the #), which browsers never send to a server, so oasdiff cannot read your specs.

Posted automatically by the oasdiff GitHub Action. The oasdiff status check passes once every change is approved; make it a required check to block merging.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants