Add logic to generate openapi response structures #18192
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
averche
added a commit
that referenced
this pull request
Dec 5, 2022
This PR modifies the path schema of `approle/path_role.go`, switching the old `Callbacks` to the equivalent `Operations` objects with a list of response fields for the 200 responses. This will allow us to generate a response structures in openapi.json. This PR is split out from #18055 along with #18192. ### Example For `GET "/auth/approle/role/{role_name}/bind-secret-id"` path, it will update the response as follows: ```diff "responses": { "200": { "description": "OK", ++ "content": { ++ "application/json": { ++ "schema": { ++ "$ref": "#/components/schemas/ApproleRoleBindSecretIdResponse" ++ } ++ } } } } ``` And will add the actual response structure: ```diff ++ "ApproleRoleBindSecretIdResponse": { ++ "type": "object", ++ "properties": { ++ "bind_secret_id": { ++ "type": "boolean", ++ "description": "Impose secret_id to be presented when logging in using this role. Defaults to 'true'." ++ } ++ } ++ }, ```
AnPucel
pushed a commit
that referenced
this pull request
Jan 14, 2023
AnPucel
pushed a commit
that referenced
this pull request
Jan 14, 2023
This PR modifies the path schema of `approle/path_role.go`, switching the old `Callbacks` to the equivalent `Operations` objects with a list of response fields for the 200 responses. This will allow us to generate a response structures in openapi.json. This PR is split out from #18055 along with #18192. ### Example For `GET "/auth/approle/role/{role_name}/bind-secret-id"` path, it will update the response as follows: ```diff "responses": { "200": { "description": "OK", ++ "content": { ++ "application/json": { ++ "schema": { ++ "$ref": "#/components/schemas/ApproleRoleBindSecretIdResponse" ++ } ++ } } } } ``` And will add the actual response structure: ```diff ++ "ApproleRoleBindSecretIdResponse": { ++ "type": "object", ++ "properties": { ++ "bind_secret_id": { ++ "type": "boolean", ++ "description": "Impose secret_id to be presented when logging in using this role. Defaults to 'true'." ++ } ++ } ++ }, ```
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.
This PR adds logic to generate
openapi.jsonresponse structures. It's been split out from #18055 for easier review process.Example
For
GET "/auth/approle/role/{role_name}/bind-secret-id"path, it will update the response as follows:"responses": { "200": { "description": "OK", ++ "content": { ++ "application/json": { ++ "schema": { ++ "$ref": "#/components/schemas/ApproleRoleBindSecretIdResponse" ++ } ++ } } } }And will add the actual response structure: