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

[templates] Update templates vendor ext standards #5295

Conversation

jimschubert
Copy link
Member

This updates the templates for a number of languages to follow the lower-kebab with x- prefix for vendor extensions as we've defined in our contributing documentation (and the x- prefix is required by OAI specification).

This fixes an issue I introduced in #5192 in which Haskell client is using additionalProperties as a sort of vendorExtension, and I'd worked to update all properties and found that those additionalProperties were not prefixed in templates with vendorExtensions.. It's possible that additionalProperties makes sense for these properties--I didn't dig into it.

The changes in this PR are simply moving to our convention. There should be no effect on template consumers/extenders as the old format vendor extensions still exist and there is a warning that the format has been deprecated in 4.3.0.

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.

@jimschubert jimschubert added this to the 4.3.0 milestone Feb 12, 2020
@jimschubert
Copy link
Member Author

cc @OpenAPITools/generator-core-team

@jimschubert
Copy link
Member Author

This PR is work toward #4976. Once merged, and master is integrated into the 5.x branch, we can remove the "old" format vendor extensions.

@jimschubert jimschubert merged commit dc50585 into OpenAPITools:master Feb 15, 2020
@jimschubert jimschubert deleted the update-templates-vendor-ext-standards branch February 15, 2020 21:26
MikailBag pushed a commit to MikailBag/openapi-generator that referenced this pull request Mar 23, 2020
* [templates] Update to vendor extension standard keys

* Fix missed value in Java template, also implements=>x-implements. Evaluate Haskell Client changes

* Fix missing accept/content-type update for vendor extension format
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.

None yet

1 participant