open-vault/changelog/18198.txt at b74e4bc781e96beeb2c9cfacc1d57e5b6711caad - luxolus/open-vault - Stateless Git Forge

luxolus/open-vault

Anton Averchenkov 545ee098ab

Add openapi response definitions to approle/path_role.go (#18198 )

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'."
++          }
++        }
++      },
```

2022-12-05 16:55:13 -05:00

4 lines

98 B

Plaintext

Raw Blame History

	```release-note:improvement
	`openapi: Add openapi response definitions to approle/path_role.go`
	```