Skip to content

Commit 9283454

Browse files
fix(openapi): update kafka-mgmt/v1 OpenAPI document (#249)
Co-authored-by: app-services-ci <app-services-ci@users.noreply.github.com>
1 parent 0d6918b commit 9283454

1 file changed

Lines changed: 69 additions & 2 deletions

File tree

.openapi/kas-fleet-manager.yaml

Lines changed: 69 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -674,6 +674,40 @@ paths:
674674
tags:
675675
- security
676676
summary: Resets the credentials for a service account by ID
677+
/api/kafkas_mgmt/v1/sso_providers:
678+
get:
679+
summary: Return sso provider info
680+
operationId: getSsoProviders
681+
security:
682+
- Bearer: [ ]
683+
tags:
684+
- security
685+
responses:
686+
'200':
687+
description: Returned list of supported cloud providers
688+
content:
689+
application/json:
690+
schema:
691+
$ref: '#/components/schemas/SsoProvider'
692+
'401':
693+
description: Auth token is invalid
694+
content:
695+
application/json:
696+
schema:
697+
$ref: '#/components/schemas/Error'
698+
examples:
699+
401Example:
700+
$ref: '#/components/examples/401Example'
701+
'500':
702+
description: Unexpected error occurred
703+
content:
704+
application/json:
705+
schema:
706+
$ref: '#/components/schemas/Error'
707+
examples:
708+
500Example:
709+
$ref: '#/components/examples/500Example'
710+
677711
#
678712
# These are the user-facing related endpoints
679713
#
@@ -1022,7 +1056,11 @@ components:
10221056
type: boolean
10231057
default: false
10241058
supported_instance_types:
1025-
description: 'The Kafka instance types supported by this region.'
1059+
deprecated: true
1060+
description: |-
1061+
The Kafka instance types supported by this region.
1062+
1063+
DEPRECATION NOTICE - instance_type will be deprecated
10261064
type: array
10271065
items:
10281066
type: string
@@ -1139,6 +1177,23 @@ components:
11391177
- kind
11401178
- items
11411179
# user-facing metrics related #
1180+
SsoProvider:
1181+
description: 'SSO Provider'
1182+
allOf:
1183+
- $ref: "#/components/schemas/ObjectReference"
1184+
- type: object
1185+
properties:
1186+
base_url:
1187+
description: 'base url'
1188+
type: string
1189+
token_url:
1190+
type: string
1191+
jwks:
1192+
type: string
1193+
valid_issuer:
1194+
type: string
1195+
example:
1196+
$ref: "#/components/examples/SsoProviderExample"
11421197
MetricsRangeQueryList:
11431198
allOf:
11441199
- type: object
@@ -1375,8 +1430,12 @@ components:
13751430
type: string
13761431
style: form
13771432
instance_type:
1433+
deprecated: true
13781434
name: instance_type
1379-
description: The Kafka instance type to filter the results by
1435+
description: |-
1436+
The Kafka instance type to filter the results by
1437+
1438+
DEPRECATION NOTICE - instance_type will be deprecated
13801439
in: query
13811440
schema:
13821441
type: string
@@ -1472,6 +1531,14 @@ components:
14721531
owner: "test-user"
14731532
created_by: "test-user"
14741533
created_at: "2021-04-07T16:24:01+05:30"
1534+
SsoProviderExample:
1535+
value:
1536+
kind: "SsoProvider"
1537+
href: "/api/kafkas_mgmt/v1/sso_providers"
1538+
base_url: "https://identity.api.redhat.com"
1539+
jwks: "https://identity.api.openshift.com/auth/realms/rhoas/protocol/openid-connect/certs"
1540+
token_url: "https://identity.api.openshift.com/auth/realms/rhoas/protocol/openid-connect/token"
1541+
valid_issuer: "https://identity.api.openshift.com/auth/realms/rhoas"
14751542
ServiceAccountByIdExample:
14761543
value:
14771544
id: "1"

0 commit comments

Comments
 (0)