[html2] Various enhancements #643
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit includes the following changes: - Fix docs not generating parameter descriptions, add rust sample. - Add example to doc output. - Add basic scope reporting. - Stringify the JSON "Example" objects for response schemas. - Prettify JSON examples in response schemas. - Parse and present multiline response descriptions. - Add API error details to docsgen. - Add read only markers to read only properties. - Fix up style document indentation. - Add support for `x-shared-errors`, an extension to define common error types that can be shared across a microservice framework.
5 tasks
wing328
approved these changes
Jul 26, 2018
wing328
changed the title
A-Joshi
pushed a commit
to ihsmarkitoss/openapi-generator
that referenced
this pull request
Feb 27, 2019
This commit includes the following changes: - Fix docs not generating parameter descriptions, add rust sample. - Add example to doc output. - Add basic scope reporting. - Stringify the JSON "Example" objects for response schemas. - Prettify JSON examples in response schemas. - Parse and present multiline response descriptions. - Add API error details to docsgen. - Add read only markers to read only properties. - Fix up style document indentation. - Add support for `x-shared-errors`, an extension to define common error types that can be shared across a microservice framework.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR checklist
./bin/to update Petstore sample so that CIs can verify the change. (For instance, only need to run./bin/{LANG}-petstore.shand./bin/security/{LANG}-petstore.shif updating the {LANG} (e.g. php, ruby, python, etc) code generator or {LANG} client's mustache templates). Windows batch files can be found in.\bin\windows\.master,3.2.x,4.0.x. Default:master.- [ ] Copied the technical committee to review the pull request if your PR is targeting a particular programming language.- doesn't seem to be a committee for html2...Description of the PR
(details of the change, additional tests that have been done, reference to the issue for tracking, etc)
This commit includes the following changes:
x-shared-errors, an extension to define common error types that can be shared across a microservice framework. Currently only supported byrust-server- I'll add it to https://github.com/OpenAPITools/openapi-generator/wiki/Vendor-Extensions once this gets merged.Required for #550. I've not specifically tested, but we have been using this for several months now without incident.
Thanks to @angusi and @kw217 - the original authors of these changes.