Demo: API changes with oasdiff PR comment#2
Conversation
- Remove 400 response from POST /api/v1.0/groups
- Remove pattern constraint from 'created' field
- Add 'description' property to GroupView
- Add GET /api/v1.0/groups/{groupId} endpoint
- Add pr-comment workflow to demonstrate oasdiff PR comment
oasdiff API Change Report🔴 1 breaking change · 🟢 2 info
Compared at commit |
…d branch Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| readOnly: true | ||
| name: | ||
| type: string | ||
| description: |
There was a problem hiding this comment.
🟢 new-optional-request-property — added the new optional request property 'data/description'
| type: string | ||
| format: date-time | ||
| readOnly: true | ||
| pattern: "^[a-z]+$" |
There was a problem hiding this comment.
🟢 request-property-pattern-removed — removed the pattern '^[a-z]+$' from the request property 'data/created'
| schema: | ||
| $ref: '#/components/schemas/GroupView' | ||
| description: SUCCESS | ||
| "400": |
There was a problem hiding this comment.
🟢 response-non-success-status-removed — removed the non-success response with the status '400'
| readOnly: true | ||
| name: | ||
| type: string | ||
| description: |
There was a problem hiding this comment.
🟢 response-optional-property-added — added the optional property 'data/description' to the response with the '200' status
| readOnly: true | ||
| name: | ||
| type: string | ||
| description: |
There was a problem hiding this comment.
🟢 new-optional-request-property — added the new optional request property 'data/description'
| type: string | ||
| format: date-time | ||
| readOnly: true | ||
| pattern: "^[a-z]+$" |
There was a problem hiding this comment.
🟢 response-property-pattern-removed — the 'data/created' response's property pattern '^[a-z]+$' was removed for the status '200'
| type: string | ||
| format: date-time | ||
| readOnly: true | ||
| pattern: "^[a-z]+$" |
There was a problem hiding this comment.
🟢 request-property-pattern-removed — removed the pattern '^[a-z]+$' from the request property 'data/created'
| schema: | ||
| $ref: '#/components/schemas/GroupView' | ||
| description: SUCCESS | ||
| "400": |
There was a problem hiding this comment.
🟢 response-non-success-status-removed — removed the non-success response with the status '400'
| "400": | ||
| summary: Create a Project | ||
| /api/v1.0/groups/{groupId}: | ||
| get: |
There was a problem hiding this comment.
🟢 endpoint-added — endpoint added
| readOnly: true | ||
| name: | ||
| type: string | ||
| description: |
There was a problem hiding this comment.
🟢 response-optional-property-added — added the optional property 'data/description' to the response with the '200' status
| type: string | ||
| format: date-time | ||
| readOnly: true | ||
| pattern: "^[a-z]+$" |
There was a problem hiding this comment.
🟢 response-property-pattern-removed — the 'data/created' response's property pattern '^[a-z]+$' was removed for the status '200'
| "400": | ||
| summary: Create a Project | ||
| /api/v1.0/groups/{groupId}: | ||
| get: |
There was a problem hiding this comment.
🟢 endpoint-added — endpoint added
| readOnly: true | ||
| name: | ||
| type: string | ||
| description: |
There was a problem hiding this comment.
🟢 new-optional-request-property — added the new optional request property 'data/description'
| readOnly: true | ||
| name: | ||
| type: string | ||
| description: |
There was a problem hiding this comment.
🟢 new-optional-request-property — added the new optional request property 'data/description'
| type: string | ||
| format: date-time | ||
| readOnly: true | ||
| pattern: "^[a-z]+$" |
There was a problem hiding this comment.
🟢 request-property-pattern-removed — removed the pattern '^[a-z]+$' from the request property 'data/created'
| type: string | ||
| format: date-time | ||
| readOnly: true | ||
| pattern: "^[a-z]+$" |
There was a problem hiding this comment.
🟢 request-property-pattern-removed — removed the pattern '^[a-z]+$' from the request property 'data/created'
| schema: | ||
| $ref: '#/components/schemas/GroupView' | ||
| description: SUCCESS | ||
| "400": |
There was a problem hiding this comment.
🟢 response-non-success-status-removed — removed the non-success response with the status '400'
| schema: | ||
| $ref: '#/components/schemas/GroupView' | ||
| description: SUCCESS | ||
| "400": |
There was a problem hiding this comment.
🟢 response-non-success-status-removed — removed the non-success response with the status '400'
| readOnly: true | ||
| name: | ||
| type: string | ||
| description: |
There was a problem hiding this comment.
🟢 response-optional-property-added — added the optional property 'data/description' to the response with the '200' status
| readOnly: true | ||
| name: | ||
| type: string | ||
| description: |
There was a problem hiding this comment.
🟢 response-optional-property-added — added the optional property 'data/description' to the response with the '200' status
simple.yaml
Outdated
| type: string | ||
| required: | ||
| - name | ||
| - id |
There was a problem hiding this comment.
🟢 response-property-became-required — the response property 'data/id' became required for the status '200'
simple.yaml
Outdated
| type: string | ||
| required: | ||
| - name | ||
| - id |
There was a problem hiding this comment.
🟢 response-property-became-required — the response property 'data/id' became required for the status '200'
| type: string | ||
| format: date-time | ||
| readOnly: true | ||
| pattern: "^[a-z]+$" |
There was a problem hiding this comment.
🟢 request-property-pattern-removed — removed the pattern '^[a-z]+$' from the request property 'data/created'
| schema: | ||
| $ref: '#/components/schemas/GroupView' | ||
| description: SUCCESS | ||
| "400": |
There was a problem hiding this comment.
🟢 response-non-success-status-removed — removed the non-success response with the status '400'
| readOnly: true | ||
| name: | ||
| type: string | ||
| description: |
There was a problem hiding this comment.
🟢 new-optional-request-property — added the new optional request property 'data/description'
| readOnly: true | ||
| name: | ||
| type: string | ||
| description: |
There was a problem hiding this comment.
🟢 response-optional-property-added — added the optional property 'data/description' to the response with the '200' status
| type: string | ||
| format: date-time | ||
| readOnly: true | ||
| pattern: "^[a-z]+$" |
There was a problem hiding this comment.
🟢 response-property-pattern-removed — the 'data/created' response's property pattern '^[a-z]+$' was removed for the status '200'
| type: string | ||
| format: date-time | ||
| readOnly: true | ||
| pattern: "^[a-z]+$" |
There was a problem hiding this comment.
🟢 request-property-pattern-removed — removed the pattern '^[a-z]+$' from the request property 'data/created'
| "400": | ||
| summary: Create a Project | ||
| /api/v1.0/groups/{groupId}: | ||
| get: |
There was a problem hiding this comment.
🟢 endpoint-added — endpoint added
| schema: | ||
| $ref: '#/components/schemas/GroupView' | ||
| description: SUCCESS | ||
| "400": |
There was a problem hiding this comment.
🟢 response-non-success-status-removed — removed the non-success response with the status '400'
| readOnly: true | ||
| name: | ||
| type: string | ||
| description: |
There was a problem hiding this comment.
🟢 response-optional-property-added — added the optional property 'data/description' to the response with the '200' status
| type: string | ||
| format: date-time | ||
| readOnly: true | ||
| pattern: "^[a-z]+$" |
There was a problem hiding this comment.
🟢 response-property-pattern-removed — the 'data/created' response's property pattern '^[a-z]+$' was removed for the status '200'
| "400": | ||
| summary: Create a Project | ||
| /api/v1.0/groups/{groupId}: | ||
| get: |
There was a problem hiding this comment.
🟢 endpoint-added — endpoint added
| paths: | ||
| /api/v1.0/groups: | ||
| /api/v1.1/groups: | ||
| post: |
There was a problem hiding this comment.
🔴 api-path-removed-without-deprecation — api path removed without deprecation
| paths: | ||
| /api/v1.0/groups: | ||
| /api/v1.1/groups: | ||
| post: |
There was a problem hiding this comment.
🔴 api-path-removed-without-deprecation — api path removed without deprecation
| "400": | ||
| summary: Create a Project | ||
| /api/v1.0/groups/{groupId}: | ||
| get: |
There was a problem hiding this comment.
🟢 endpoint-added — endpoint added
| "400": | ||
| summary: Create a Project | ||
| /api/v1.0/groups/{groupId}: | ||
| get: |
There was a problem hiding this comment.
🟢 endpoint-added — endpoint added
| paths: | ||
| /api/v1.0/groups: | ||
| /api/v1.1/groups: | ||
| post: |
There was a problem hiding this comment.
🟢 endpoint-added — endpoint added
| paths: | ||
| /api/v1.0/groups: | ||
| /api/v1.1/groups: | ||
| post: |
There was a problem hiding this comment.
🟢 endpoint-added — endpoint added
| paths: | ||
| /api/v1.0/groups: | ||
| /api/v1.1/groups: | ||
| post: |
There was a problem hiding this comment.
🔴 api-path-removed-without-deprecation — api path removed without deprecation
| paths: | ||
| /api/v1.0/groups: | ||
| /api/v1.1/groups: | ||
| post: |
There was a problem hiding this comment.
🟢 endpoint-added — endpoint added
| paths: | ||
| /api/v1.0/groups: | ||
| /api/v1.1/groups: | ||
| post: |
There was a problem hiding this comment.
🔴 api-path-removed-without-deprecation — api path removed without deprecation
| paths: | ||
| /api/v1.0/groups: | ||
| /api/v1.1/groups: | ||
| post: |
There was a problem hiding this comment.
🟢 endpoint-added — endpoint added
| paths: | ||
| /api/v1.0/groups: | ||
| /api/v1.2/groups: | ||
| post: |
There was a problem hiding this comment.
🔴 api-path-removed-without-deprecation — api path removed without deprecation
| paths: | ||
| /api/v1.0/groups: | ||
| /api/v1.2/groups: | ||
| post: |
There was a problem hiding this comment.
🟢 endpoint-added — endpoint added
| paths: | ||
| /api/v1.0/groups: | ||
| /api/v1.2/groups: | ||
| post: |
There was a problem hiding this comment.
🔴 api-path-removed-without-deprecation — api path removed without deprecation
| paths: | ||
| /api/v1.0/groups: | ||
| /api/v1.2/groups: | ||
| post: |
There was a problem hiding this comment.
🟢 endpoint-added — endpoint added
- Revert simple.yaml to clean state (remove test breaking changes) - Switch action from @phase3-action-payload to @v0.0.33 - Remove service-url override (now uses production api.oasdiff.com) Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 participant
This PR demonstrates the oasdiff PR comment feature.
API changes in this PR:
400response fromPOST /api/v1.0/groups(breaking)patternconstraint fromcreatedfield (breaking)descriptionproperty toGroupView(info)GET /api/v1.0/groups/{groupId}endpoint (info)The
pr-commentworkflow will automatically post an oasdiff API change report as a comment on this PR.