-
Notifications
You must be signed in to change notification settings - Fork 421
fix(spec): update OAS to 3.0.4 and fix core rules #168
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
fix(spec): update OAS to 3.0.4 and fix core rules #168
Conversation
cdf24e9 to
c1f0f81
Compare
src/main/resources/openapi.yaml
Outdated
| version: 1.0.20-SNAPSHOT | ||
| title: Swagger Petstore - OpenAPI 3.0 | ||
| termsOfService: 'http://swagger.io/terms/' | ||
| termsOfService: http://swagger.io/terms/ |
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.
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.
This is just for example purposes. It redirects to https://smartbear.com/terms-of-use/
char0n
left a comment
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.
Note to general consistency of summary and description fields: some starts with lower case, some with upper case, some ends with . and some don't.
Can I suggest to start both summary and description with uppercase and add dot only to description? This would unify the styling consistenci a bit.
char0n
left a comment
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.
LGTM
frantuma
left a comment
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.
Related to addition of:
default:
description: Unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
The current code does not respond with an Error json structure in case of errors (it actually responds with plain text but with json content type..). We can proceed with the changes anyway being this a demo site, and fix the code in scope of different ticket, otherwise we would need to include the changes in this PR
c25d7d8 to
2d041ef
Compare
addressing some core rule violations in the OAS description