[Python] 5094 followup - Reduce redundancy in docs #5161
Merged
Conversation
This file contains hidden or 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
spacether
changed the title
spacether
reviewed
Jan 30, 2020
modules/openapi-generator/src/main/resources/python/api_doc_example.mustache
Outdated
Show resolved
Hide resolved
spacether
reviewed
Jan 30, 2020
...les/openapi-generator/src/main/resources/python/python-experimental/api_doc_example.mustache
Outdated
Show resolved
Hide resolved
spacether
suggested changes
Jan 30, 2020
Contributor
spacether
left a comment
spacether
left a comment
There was a problem hiding this comment.
Please instantiate a configuration instance in the endpoint docs if that endpoint has at least one auth method
This is a followup to PR OpenAPITools#5094, which had a few unresolved comments at merge time. This reduces the amount of redundant lines in the api example doc templates, and ensures that referenced Configuration objects are actually instantiated.
fabianvf
force-pushed
the
5094-followup
branch
from
20f9aee to
f2cc3ad
Compare
spacether
suggested changes
Feb 6, 2020
Contributor
spacether
left a comment
spacether
left a comment
There was a problem hiding this comment.
Your CircleCI test are failing because other python generator samples need to be regenerated with your updates. bin/ensure-up-to-date will regenerate those samples.
Once the tests pass, this PR can be merged.
Can you run bin/ensure-up-to-date?
Contributor
Author
|
@spacether was running it as you typed :) |
Contributor
Author
|
@spacether think it's just blocked on your review now |
MikailBag
pushed a commit
to MikailBag/openapi-generator
that referenced
this pull request
Mar 23, 2020
* Reduce redundancy in python docs This is a followup to PR OpenAPITools#5094, which had a few unresolved comments at merge time. This reduces the amount of redundant lines in the api example doc templates, and ensures that referenced Configuration objects are actually instantiated. * Regenerate samples
Member
|
@fabianvf thanks for the PR, which has been included in the 4.3.0 release: https://twitter.com/oas_generator/status/1243455743937789952 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
This is a followup to PR #5094, which had a few unresolved comments at merge time. This reduces the amount of redundant lines in the api example doc templates, and ensures that referenced Configuration objects are actually instantiated.
PR checklist
./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.shif updating the code or mustache templates for a language ({LANG}) (e.g. php, ruby, python, etc).master,4.3.x,5.0.x. Default:master.cc @taxpon @frol @mbohlool @cbornet @kenjones-cisco @tomplus @Jyhess @slash-arun @spacether