Api auth required openapi #10971
Draft
Api auth required openapi #10971
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
jp-tosca
added
Size: 3
pdurbin
reviewed
Oct 25, 2024
| @@ -1269,6 +1270,7 @@ private String getWebappImageResource(String imageName) { | |||
| }) | |||
| @Tag(name = "saveAuxiliaryFileWithVersion", | |||
| description = "Save Auxiliary File With Version") | |||
| @SecurityRequirement(name = "api_token") | |||
There was a problem hiding this comment.
Why is it "api_token" and not "API token" or "API_Token" or whatever else? Is it arbitrary?
There was a problem hiding this comment.
Seems that we also have to define the "security schema" and we name that security schema, we also set a type. The security schema could be named something else but in this case api_key is the name
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.
What this PR does / why we need it:
There was a conversation on zullip at for the need of documenting the authentication requirements on the OpenAPI specification.
Which issue(s) this PR closes: