We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
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
When using the cli to create a changelog, adding an optional request body is ignored. They are detected by diff and summary though.
changelog
diff
summary
Steps to reproduce the behavior:
oasdiff changelog openapi.yaml openapi-new.yaml
openapi.yaml
openapi: 3.0.0 info: title: Test API version: 1.0.0 paths: /ducks: post: responses: '200': description: A duck content: application/json: schema: $ref: '#/components/schemas/Duck' components: schemas: Duck: type: object properties: name: type: string age: type: integer
openapi-new.yaml
openapi: 3.0.0 info: title: Test API version: 1.0.0 paths: /ducks: post: requestBody: content: application/json: schema: $ref: '#/components/schemas/Duck' responses: '200': description: A duck content: application/json: schema: $ref: '#/components/schemas/Duck' components: schemas: Duck: type: object properties: name: type: string age: type: integer
I expected the addition of the new request body in the path to be logged with a info level, as shown below.
info
1 changes: 0 error, 0 warning, 1 info info [request-body-added] at openapi-new.yaml in API POST /ducks request body added
The changes are detected by diff and summary
> oasdiff diff openapi.yaml openapi-new.yaml paths: modified: /ducks: operations: modified: POST: requestBody: added: true endpoints: modified: ? method: POST path: /ducks : requestBody: added: true
> oasdiff summary openapi.yaml openapi-new.yaml diff: true details: endpoints: modified: 1 paths: modified: 1
The text was updated successfully, but these errors were encountered:
While I'm fixing this, I'd also like to add a check for removing a request body.
Can you please provide your feedback:
Sorry, something went wrong.
Sorry by the late response. I agree with your implementation, it should be INFO if the body is optional and ERR if it is required.
INFO
ERR
Successfully merging a pull request may close this issue.
Describe the bug
When using the cli to create a
changelog
, adding an optional request body is ignored. They are detected bydiff
andsummary
though.To Reproduce
Steps to reproduce the behavior:
openapi.yaml
openapi-new.yaml
Expected behavior
I expected the addition of the new request body in the path to be logged with a
info
level, as shown below.Desktop
Additional context
The changes are detected by
diff
andsummary
The text was updated successfully, but these errors were encountered: