Skip to content
GitLab

[html2] Various enhancements

Merged Administrator requested to merge github/fork/Metaswitch/html2-changes-merge into master

Created by: bjgill

PR checklist

  • Read the contribution guidelines.
  • Ran the shell script under ./bin/ to update Petstore sample so that CIs can verify the change. (For instance, only need to run ./bin/{LANG}-petstore.sh and ./bin/security/{LANG}-petstore.sh if 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\.
  • Filed the PR against the correct branch: 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:

  • 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. Currently only supported by rust-server - I'll add it to https://github.com/OpenAPITools/openapi-generator/wiki/Vendor-Extensions once this gets merged.

Required for https://github.com/OpenAPITools/openapi-generator/issues/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.