Skip to content

Conversation

@frankkilcommins
Copy link
Contributor

addressing some core rule violations in the OAS description

@frantuma frantuma force-pushed the petstore-revamp-3.0 branch from cdf24e9 to c1f0f81 Compare March 12, 2025 10:26
version: 1.0.20-SNAPSHOT
title: Swagger Petstore - OpenAPI 3.0
termsOfService: 'http://swagger.io/terms/'
termsOfService: http://swagger.io/terms/
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Contributor Author

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/

Copy link
Contributor

@char0n char0n left a 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.

Copy link
Contributor

@char0n char0n left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link
Contributor

@frantuma frantuma left a 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

@frantuma frantuma force-pushed the petstore-revamp-3.0 branch from c25d7d8 to 2d041ef Compare March 19, 2025 17:40
@frantuma frantuma merged commit aa28cc1 into swagger-api:master Mar 19, 2025
4 checks passed
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.

3 participants