-
Notifications
You must be signed in to change notification settings - Fork 0
Demo: API changes with oasdiff PR comment #2
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
e622138
b27527f
36a5910
b0601c0
bc44ba4
aac2d97
90c7337
97b8c6d
c0ab3bc
9671293
d07835f
823d8a3
5098c4a
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| name: oasdiff PR comment | ||
|
|
||
| on: | ||
| pull_request: | ||
|
|
||
| permissions: | ||
| contents: read | ||
| pull-requests: write | ||
| statuses: write | ||
|
|
||
| jobs: | ||
| pr-comment: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Check out code | ||
| uses: actions/checkout@v4 | ||
|
|
||
| - name: Post oasdiff PR comment | ||
| uses: oasdiff/oasdiff-action/pr-comment@v0.0.33 | ||
| with: | ||
| base: https://raw.githubusercontent.com/${{ github.repository }}/${{ github.base_ref }}/simple.yaml | ||
| revision: simple.yaml | ||
| oasdiff-token: 0634345d-02fb-43df-b56a-68fc22253621 |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,15 +1,15 @@ | ||
| openapi: 3.0.1 | ||
| info: | ||
| title: Tufin | ||
| version: "3.0" | ||
| version: "4.0" | ||
| servers: | ||
| - url: https://localhost:8080 | ||
| components: | ||
| parameters: | ||
| groupId: | ||
| in: query | ||
| name: groupId | ||
| required: false | ||
| required: true | ||
| schema: | ||
| type: string | ||
| schemas: | ||
|
|
@@ -23,16 +23,17 @@ components: | |
| type: string | ||
| format: date-time | ||
| readOnly: true | ||
| pattern: "^[a-z]+$" | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🟢 response-property-pattern-removed — the 'data/created' response's property pattern '^[a-z]+$' was removed for the status '200' There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🟢 request-property-pattern-removed — removed the pattern '^[a-z]+$' from the request property 'data/created' There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🟢 response-property-pattern-removed — the 'data/created' response's property pattern '^[a-z]+$' was removed for the status '200' There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🟢 request-property-pattern-removed — removed the pattern '^[a-z]+$' from the request property 'data/created' There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🟢 request-property-pattern-removed — removed the pattern '^[a-z]+$' from the request property 'data/created' There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🟢 response-property-pattern-removed — the 'data/created' response's property pattern '^[a-z]+$' was removed for the status '200' There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🟢 response-property-pattern-removed — the 'data/created' response's property pattern '^[a-z]+$' was removed for the status '200' There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🟢 request-property-pattern-removed — removed the pattern '^[a-z]+$' from the request property 'data/created' There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🟢 response-property-pattern-removed — the 'data/created' response's property pattern '^[a-z]+$' was removed for the status '200' There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🟢 request-property-pattern-removed — removed the pattern '^[a-z]+$' from the request property 'data/created' There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🟢 response-property-pattern-removed — the 'data/created' response's property pattern '^[a-z]+$' was removed for the status '200' |
||
| id: | ||
| type: string | ||
| readOnly: true | ||
| name: | ||
| type: string | ||
| description: | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🟢 new-optional-request-property — added the new optional request property 'data/description' There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🟢 response-optional-property-added — added the optional property 'data/description' to the response with the '200' status There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🟢 new-optional-request-property — added the new optional request property 'data/description' There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🟢 response-optional-property-added — added the optional property 'data/description' to the response with the '200' status There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🟢 new-optional-request-property — added the new optional request property 'data/description' There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🟢 new-optional-request-property — added the new optional request property 'data/description' There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🟢 response-optional-property-added — added the optional property 'data/description' to the response with the '200' status There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🟢 response-optional-property-added — added the optional property 'data/description' to the response with the '200' status There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🟢 new-optional-request-property — added the new optional request property 'data/description' There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🟢 new-optional-request-property — added the new optional request property 'data/description' There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🟢 response-optional-property-added — added the optional property 'data/description' to the response with the '200' status There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🟢 response-optional-property-added — added the optional property 'data/description' to the response with the '200' status |
||
| type: string | ||
| required: | ||
| - name | ||
| paths: | ||
| /api/v1.0/groups: | ||
| /api/v1.2/groups: | ||
| post: | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🔴 api-path-removed-without-deprecation — api path removed without deprecation There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🔴 api-path-removed-without-deprecation — api path removed without deprecation There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🟢 endpoint-added — endpoint added There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🟢 endpoint-added — endpoint added There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🔴 api-path-removed-without-deprecation — api path removed without deprecation There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🟢 endpoint-added — endpoint added There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🔴 api-path-removed-without-deprecation — api path removed without deprecation There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🟢 endpoint-added — endpoint added There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🔴 api-path-removed-without-deprecation — api path removed without deprecation There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🟢 endpoint-added — endpoint added There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🔴 api-path-removed-without-deprecation — api path removed without deprecation There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🟢 endpoint-added — endpoint added |
||
| tags: | ||
| - Group | ||
|
|
@@ -51,10 +52,19 @@ paths: | |
| schema: | ||
| $ref: '#/components/schemas/GroupView' | ||
| description: SUCCESS | ||
| "400": | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🟢 response-non-success-status-removed — removed the non-success response with the status '400' There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🟢 response-non-success-status-removed — removed the non-success response with the status '400' There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🟢 response-non-success-status-removed — removed the non-success response with the status '400' There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🟢 response-non-success-status-removed — removed the non-success response with the status '400' There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🟢 response-non-success-status-removed — removed the non-success response with the status '400' There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🟢 response-non-success-status-removed — removed the non-success response with the status '400' |
||
| summary: Create a Project | ||
| /api/v1.0/groups/{groupId}: | ||
| get: | ||
| tags: | ||
| - Group | ||
| operationId: getOneGroup | ||
| parameters: | ||
| - $ref: '#/components/parameters/groupId' | ||
| responses: | ||
| "200": | ||
| content: | ||
| application/json: | ||
| schema: | ||
| $ref: '#/components/schemas/GroupView' | ||
| description: Conflict | ||
| summary: Create a Project | ||
| description: SUCCESS | ||
| summary: Get a Project | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🟢 request-property-pattern-removed — removed the pattern '^[a-z]+$' from the request property 'data/created'