Skip to content
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

swagger-core 2.1.1 && swagger-parser 2.0.17 #4915

Merged
merged 1 commit into from Jan 14, 2020

Conversation

@sullis
Copy link
Contributor

sullis commented Jan 2, 2020

notes: https://github.com/swagger-api/swagger-parser/releases

PR checklist

  • Read the contribution guidelines.
  • If contributing template-only or documentation-only changes which will change sample output, build the project before.
  • Run the shell script(s) under ./bin/ (or Windows batch scripts under.\bin\windows) to update Petstore samples related to your fix. This is important, as CI jobs will verify all generator outputs of your HEAD commit, and these must match the expectations made by your contribution. You only need to run ./bin/{LANG}-petstore.sh, ./bin/openapi3/{LANG}-petstore.sh if updating the code or mustache templates for a language ({LANG}) (e.g. php, ruby, python, etc).
  • File the PR against the correct branch: master, 4.3.x, 5.0.x. Default: master.
  • Copy the technical committee to review the pull request if your PR is targeting a particular programming language.
@sullis sullis force-pushed the sullis:swagger-parser-2.0.17 branch 5 times, most recently from 7bdea0c to 31b50ab Jan 2, 2020
@sullis sullis changed the title swagger-parser 2.0.17 swagger-core 2.1.1 && swagger-parser 2.0.17 Jan 2, 2020
@sullis sullis force-pushed the sullis:swagger-parser-2.0.17 branch 2 times, most recently from 211dcba to a592c5e Jan 3, 2020
- swagger-parser 2.0.17
- swagger-core 2.1.1
- jackson 2.10.1
@sullis sullis force-pushed the sullis:swagger-parser-2.0.17 branch from a592c5e to 77f9c63 Jan 3, 2020
@@ -178,7 +178,7 @@ public void testToYamlStringMinimalExample() throws Exception {
" description: Some description\n" +
" operationId: pingOp\n" +
" responses:\n" +
" 200:\n" +
" \"200\":\n" +

This comment has been minimized.

Copy link
@wing328

wing328 Jan 10, 2020

Member

@OpenAPITools/generator-core-team HTTP response code is now in the form of string instead of integer.

I don't see any mention of this change in swagger core/parser change log or release note.

I think we should highlight this change in our release note so users won't be surprised if the HTTP status code is now a string instead of an integer.

This comment has been minimized.

Copy link
@etherealjoy

etherealjoy Jan 10, 2020

Contributor

Can't we convert it before consuming?

This comment has been minimized.

Copy link
@wing328

wing328 Jan 10, 2020

Member

We can but someone may have already processed these numeric status codes in their app and this change may break their app. To fix it, the users need to do the conversion.

This comment has been minimized.

Copy link
@jimschubert

jimschubert Jan 14, 2020

Member

@wing328 this is documented on the Responses object:

This field MUST be enclosed in quotation marks (for example, "200") for compatibility between JSON and YAML.

https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#patterned-fields-1

This comment has been minimized.

Copy link
@jimschubert

jimschubert Jan 14, 2020

Member

I believe YAML keys are always considered strings, so someone parsing this manually through YAML should be unaffected. We could verify in YAML spec, but probably lower priority than fixing a bug that makes the doc non-compliant with the spec.

This comment has been minimized.

Copy link
@wing328

wing328 Jan 14, 2020

Member

OK. Let's go ahead with this change. I'll update the samples after the merge.

@wing328 wing328 added this to the 4.2.3 milestone Jan 14, 2020
@wing328 wing328 merged commit 6a48dd7 into OpenAPITools:master Jan 14, 2020
5 of 6 checks passed
5 of 6 checks passed
ci/circleci Your tests failed on CircleCI
Details
Shippable Run 13445 status is SUCCESS.
Details
ci/bitrise/4a2b10a819d12b67/pr Passed - openapi-generator
Details
continuous-integration/appveyor/pr AppVeyor build succeeded
Details
continuous-integration/drone/pr Build is passing
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
4 participants
You can’t perform that action at this time.