proto/api: improve auth method service API docs #4616
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
johanbrandhorst
force-pushed
the
jbrandhorst-further-api-improvements
branch
from
f291b66
to
e11fc78
Compare
johanbrandhorst
force-pushed
the
jbrandhorst-further-api-improvements
branch
from
e11fc78
to
249b5de
Compare
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.
Updates the auth method API documentation along the patterns established in #4555.
Reviewers: copy the contents of controller.swagger.json and upload to https://developer.hashicorp.services/open-api-docs-preview to review the look of the changes. Feel free to also try uploading it to https://editor-next.swagger.io/ to compare against a more capable OpenAPIv2 renderer. Note that the developer preview OpenAPI docs page suffers a few issues. If you see anything that isn't already mentioned in the feedback doc, let me know.