diff --git a/openapi.yaml b/openapi.yaml index 607cbd5..1c3d7f8 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -102,6 +102,27 @@ paths: - ACLs parameters: - $ref: '#/components/parameters/controlPlaneId' + /v2/control-planes/{controlPlaneId}/core-entities/acls/{ACLId}: + get: + operationId: get-acl + summary: Fetch an ACL + description: Get an ACL using ID. + responses: + '200': + description: Successfully fetched ACL + content: + application/json: + schema: + $ref: '#/components/schemas/ACL' + '401': + $ref: '#/components/responses/HTTP401Error' + '404': + description: Resource does not exist + tags: + - ACLs + parameters: + - $ref: '#/components/parameters/ACLId' + - $ref: '#/components/parameters/controlPlaneId' /v2/control-planes/{controlPlaneId}/core-entities/basic-auths: get: operationId: list-basic-auth @@ -133,6 +154,27 @@ paths: - Basic-auth credentials parameters: - $ref: '#/components/parameters/controlPlaneId' + /v2/control-planes/{controlPlaneId}/core-entities/basic-auths/{BasicAuthId}: + get: + operationId: get-basic-auth + summary: Fetch a Basic-auth credential + description: Get a Basic-auth credential using ID. + responses: + '200': + description: Successfully fetched Basic-auth credential + content: + application/json: + schema: + $ref: '#/components/schemas/BasicAuth' + '401': + $ref: '#/components/responses/HTTP401Error' + '404': + description: Resource does not exist + tags: + - Basic-auth credentials + parameters: + - $ref: '#/components/parameters/BasicAuthId' + - $ref: '#/components/parameters/controlPlaneId' /v2/control-planes/{controlPlaneId}/core-entities/ca_certificates: get: operationId: list-ca_certificate @@ -569,6 +611,19 @@ paths: tags: - Consumer Groups /v2/control-planes/{controlPlaneId}/core-entities/consumer_groups/{ConsumerGroupId}/consumers: + delete: + operationId: remove-all-consumers-from-consumer-group + summary: Remove consumers from consumer group + description: >- + Removes all consumers from a consumer groups. This operation does not + delete the consumer group. + responses: + '204': + description: Consumers removed from group + '404': + description: Consumer group or consumer association does not exist + tags: + - Consumer Groups get: operationId: list-consumers-for-consumer-group summary: List all Consumers in a Consumer Group @@ -866,6 +921,21 @@ paths: tags: - Consumers /v2/control-planes/{controlPlaneId}/core-entities/consumers/{ConsumerId}/consumer_groups: + delete: + operationId: remove-consumer-from-all-consumer-groups + summary: Remove consumer from consumer group + description: >- + Removes a consumer from all consumer groups. This operation does not + delete the consumer group. + parameters: + - $ref: '#/components/parameters/ConsumerId' + responses: + '204': + description: Consumer removed from all groups + '404': + description: Consumer does not exist + tags: + - Consumer Groups get: operationId: list-consumer-groups-for-consumer summary: List all Consumer Groups a Consumer belongs to @@ -1743,6 +1813,27 @@ paths: - HMAC-auth credentials parameters: - $ref: '#/components/parameters/controlPlaneId' + /v2/control-planes/{controlPlaneId}/core-entities/hmac-auths/{HMACAuthId}: + get: + operationId: get-hmac-auth + summary: Fetch a HMAC-auth credential + description: Get a HMAC-auth credential using ID. + responses: + '200': + description: Successfully fetched HMAC-auth credential + content: + application/json: + schema: + $ref: '#/components/schemas/HMACAuth' + '401': + $ref: '#/components/responses/HTTP401Error' + '404': + description: Resource does not exist + tags: + - HMAC-auth credentials + parameters: + - $ref: '#/components/parameters/HMACAuthId' + - $ref: '#/components/parameters/controlPlaneId' /v2/control-planes/{controlPlaneId}/core-entities/jwts: get: operationId: list-jwt @@ -1774,6 +1865,27 @@ paths: - JWTs parameters: - $ref: '#/components/parameters/controlPlaneId' + /v2/control-planes/{controlPlaneId}/core-entities/jwts/{JWTId}: + get: + operationId: get-jwt + summary: Fetch a JWT + description: Get a JWT using ID. + responses: + '200': + description: Successfully fetched JWT + content: + application/json: + schema: + $ref: '#/components/schemas/JWT' + '401': + $ref: '#/components/responses/HTTP401Error' + '404': + description: Resource does not exist + tags: + - JWTs + parameters: + - $ref: '#/components/parameters/JWTId' + - $ref: '#/components/parameters/controlPlaneId' /v2/control-planes/{controlPlaneId}/core-entities/key-auths: get: operationId: list-key-auth @@ -1805,6 +1917,27 @@ paths: - API-keys parameters: - $ref: '#/components/parameters/controlPlaneId' + /v2/control-planes/{controlPlaneId}/core-entities/key-auths/{KeyAuthId}: + get: + operationId: get-key-auth + summary: Fetch an API-key + description: Get an API-key using ID. + responses: + '200': + description: Successfully fetched API-key + content: + application/json: + schema: + $ref: '#/components/schemas/KeyAuth' + '401': + $ref: '#/components/responses/HTTP401Error' + '404': + description: Resource does not exist + tags: + - API-keys + parameters: + - $ref: '#/components/parameters/KeyAuthId' + - $ref: '#/components/parameters/controlPlaneId' /v2/control-planes/{controlPlaneId}/core-entities/key-sets: get: operationId: list-key-set @@ -2162,6 +2295,27 @@ paths: - MTLS-auth credentials parameters: - $ref: '#/components/parameters/controlPlaneId' + /v2/control-planes/{controlPlaneId}/core-entities/mtls-auths/{MTLSAuthId}: + get: + operationId: get-mtls-auth + summary: Fetch a MTLS-auth credential + description: Get a MTLS-auth credential using ID. + responses: + '200': + description: Successfully fetched MTLS-auth credential + content: + application/json: + schema: + $ref: '#/components/schemas/MTLSAuth' + '401': + $ref: '#/components/responses/HTTP401Error' + '404': + description: Resource does not exist + tags: + - MTLS-auth credentials + parameters: + - $ref: '#/components/parameters/MTLSAuthId' + - $ref: '#/components/parameters/controlPlaneId' /v2/control-planes/{controlPlaneId}/core-entities/plugin-schemas: parameters: - $ref: '#/components/parameters/controlPlaneId' @@ -8816,7 +8970,6 @@ components: vaults' documentation page. type: object additionalProperties: true - nullable: true created_at: description: Unix epoch when the resource was created. type: integer @@ -8864,6 +9017,7 @@ components: required: - name - prefix + - config requestBodies: GroupMembershipAdd: content: @@ -9461,7 +9615,10 @@ components: content: application/json: schema: - $ref: '#/components/schemas/GroupStatus' + type: object + properties: + item: + $ref: '#/components/schemas/GroupStatus' GetGroupMemberStatus: description: Determines the group membership status of a control plane. content: