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

[docs] Document new templating engine, adding ability to reference templates #2773

Merged
merged 1 commit into from
May 5, 2019

Conversation

jimschubert
Copy link
Member

@jimschubert jimschubert commented May 1, 2019

Document new templating engine, adding the ability to reference templates by file to complete the example

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, ./bin/openapi3/{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.4.x, 4.0.x. Default: master.
  • Copied the technical committee to review the pull request if your PR is targeting a particular programming language.

Description of the PR

Adds documentation around new templating engine support, and calls out that this support is consider experimental. This means we may modify the interfaces or remove support until we no longer consider it "experimental".

@jimschubert
Copy link
Member Author

/cc @OpenAPITools/openapi-generator-core-team

@wing328 wing328 added this to the 4.0.0 milestone May 5, 2019
@wing328 wing328 changed the title [docs] Document new templating engine, adding ability to reference te… [docs] Document new templating engine, adding ability to reference templates May 5, 2019
Copy link
Member

@wing328 wing328 left a comment

Choose a reason for hiding this comment

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

LGTM

@wing328 wing328 merged commit a02cb19 into master May 5, 2019
@wing328 wing328 deleted the custom-templating-doc branch May 5, 2019 10:03
jimschubert added a commit that referenced this pull request May 5, 2019
* master:
  resize lightbow logo
  add lightbow logo
  add Lightbow as sponsor (#2822)
  [docs] Document new templating engine, adding ability to reference templates by file to comlete the example (#2773)
  [JAVA][KOTLIN] fix var Naming for all uppercase with Numbers (#2794)
  [Documentation] Add instructions to build the javascript client module (#2806)
  use mvn instead of run-in-docker (#2821)
  Better handling of form data (#2818)
  [haskell-servant] Add some missing types to the generated modules (#2675)
jimschubert added a commit that referenced this pull request May 5, 2019
* master:
  resize lightbow logo
  add lightbow logo
  add Lightbow as sponsor (#2822)
  [docs] Document new templating engine, adding ability to reference templates by file to comlete the example (#2773)
  [JAVA][KOTLIN] fix var Naming for all uppercase with Numbers (#2794)
  [Documentation] Add instructions to build the javascript client module (#2806)
  use mvn instead of run-in-docker (#2821)
  Better handling of form data (#2818)
  [haskell-servant] Add some missing types to the generated modules (#2675)
  Clarifies need to build project for sample output (#2819)
  [Elm] Bugfix .encode in modelTypeDiscriminator (#2807)
  Apply strict spec option to CodegenConfig instance (#2814)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants