diff --git a/api-specs/konnect/analytics-dashboards/openapi.yaml b/api-specs/konnect/analytics-dashboards/openapi.yaml index dfad1e3938..a95fee7234 100644 --- a/api-specs/konnect/analytics-dashboards/openapi.yaml +++ b/api-specs/konnect/analytics-dashboards/openapi.yaml @@ -482,6 +482,7 @@ components: field: ai_request_model value: - request_model1 + nullable: false additionalProperties: false required: - tiles @@ -1935,6 +1936,7 @@ components: chart_title: description: 'The title of the chart, which is displayed in the tile''s header.' type: string + nullable: false type: type: string enum: @@ -1958,6 +1960,7 @@ components: chart_title: description: 'The title of the chart, which is displayed in the tile''s header.' type: string + nullable: false type: type: string enum: @@ -1967,6 +1970,7 @@ components: description: | Whether to stack the bars or lines (implicitly adding them together to form a total), or leave them independent from each other. type: boolean + nullable: false additionalProperties: false required: - type @@ -1980,6 +1984,7 @@ components: chart_title: description: 'The title of the chart, which is displayed in the tile''s header.' type: string + nullable: false type: type: string enum: @@ -1989,6 +1994,7 @@ components: description: | Whether to stack the bars (implicitly adding them together to form a total), or leave them independent from each other. type: boolean + nullable: false additionalProperties: false required: - type @@ -2000,6 +2006,7 @@ components: chart_title: description: 'The title of the chart, which is displayed in the tile''s header.' type: string + nullable: false type: type: string enum: diff --git a/api-specs/konnect/control-planes-config/v2/openapi.yaml b/api-specs/konnect/control-planes-config/v2/openapi.yaml index 1a62b8a892..46d3cdb97c 100644 --- a/api-specs/konnect/control-planes-config/v2/openapi.yaml +++ b/api-specs/konnect/control-planes-config/v2/openapi.yaml @@ -461,7 +461,7 @@ paths: get: operationId: get-config-store-secret summary: Fetch Config Store Secret - description: Returns a secret for the Config Store. + description: Returns the secret entity for the Config Store. Secret values once stored cannot be retrieved. responses: '200': $ref: '#/components/responses/ConfigStoreSecretResponse' @@ -4674,6 +4674,7 @@ components: value: type: string writeOnly: true + x-sensitive: true created_at: $ref: '#/components/schemas/CreatedAt' updated_at: @@ -4690,6 +4691,7 @@ components: maxLength: 5120 minLength: 1 writeOnly: true + x-sensitive: true required: - key - value @@ -4701,6 +4703,7 @@ components: maxLength: 5120 minLength: 1 writeOnly: true + x-sensitive: true required: - value ACL: diff --git a/api-specs/konnect/identity/v3/openapi.yaml b/api-specs/konnect/identity/v3/openapi.yaml index 2286ad9319..1fa04cb83b 100644 --- a/api-specs/konnect/identity/v3/openapi.yaml +++ b/api-specs/konnect/identity/v3/openapi.yaml @@ -3044,6 +3044,8 @@ components: name: description: Name of the system account access token. type: string + required: + - name CreateSystemAccountAccessToken: content: application/json: @@ -3055,6 +3057,9 @@ components: expires_at: type: string format: date-time + required: + - name + - expires_at examples: Sample Access Token: value: @@ -4319,6 +4324,7 @@ components: description: The token of the system account access token. type: string readOnly: true + x-sensitive: true example: id: 497f6eca-6276-4993-bfeb-53cbbbba6f08 name: Sample Access Token diff --git a/api-specs/konnect/service-catalog/v1/openapi.yaml b/api-specs/konnect/service-catalog/v1/openapi.yaml index 43ca108f9a..09c2d1f21d 100644 --- a/api-specs/konnect/service-catalog/v1/openapi.yaml +++ b/api-specs/konnect/service-catalog/v1/openapi.yaml @@ -1600,6 +1600,7 @@ components: - $ref: '#/components/schemas/CreateOAuthCredential' - $ref: '#/components/schemas/CreateGitHubAppInstallationCredential' - $ref: '#/components/schemas/CreateMultiKeyAuthCredential' + - $ref: '#/components/schemas/CreateAWSRoleDelegationAuthCredential' title: CreateIntegrationInstanceAuthCredential IntegrationInstanceAuthCredential: description: Object containing metadata for an integration instance auth credential. @@ -1607,6 +1608,7 @@ components: - $ref: '#/components/schemas/OAuthCredential' - $ref: '#/components/schemas/GitHubAppInstallationCredential' - $ref: '#/components/schemas/MultiKeyAuthCredential' + - $ref: '#/components/schemas/AWSRoleDelegationAuthCredential' title: IntegrationInstanceAuthCredential CreateOAuthCredential: description: Payload used to create an `OAuth` credential for an integration instance. @@ -1719,6 +1721,30 @@ components: - type - config writeOnly: true + CreateAWSRoleDelegationAuthCredential: + description: Payload used to create an `AWS Role Delegation` credential for an integration instance. + type: object + properties: + type: + type: string + enum: + - aws_role_delegation + config: + type: object + additionalProperties: false + properties: + role_arn: + description: | + The AWS Role ARN string + type: string + example: 'arn:aws:iam::084735895545:role/KonnectServiceCatalogRole' + required: + - role_arn + title: CreateAWSRoleDelegationAuthCredentialConfig + additionalProperties: false + required: + - type + - config OAuthCredential: description: Represents a credential scoped to an integration instance that supports the `OAuth` authorization strategy. type: object @@ -1869,6 +1895,60 @@ components: - created_at - type title: MultiKeyAuthCredential + AWSRoleDelegationAuthCredential: + description: Represents a credential scoped to an integration instance that supports the `AWS Role Delegation` authorization strategy. + type: object + properties: + id: + type: string + format: uuid + example: 4f535923-ec24-456c-b4e5-e67f65c8c208 + integration_instance: + $ref: '#/components/schemas/IntegrationInstanceRef' + missing_permissions: + description: List of detected missing permissions required to enable the full functionality of the given integration instance. + type: array + items: + $ref: '#/components/schemas/MissingPermission' + tainted: + description: Indicates that the credential is no longer valid and must be replaced with a new valid credential. + type: boolean + example: false + expires_at: + description: | + Timestamp denoting when the when the credential will expire in RFC-3339 format with a "T" character separating date from time within the field value. + When expired, the credential must be replaced with a new valid credential to re-enable full functionality for the given integration instance. + + A `null` value indicates no known expiration time. + type: string + format: date-time + example: '2025-04-01T07:20:50Z' + nullable: true + created_at: + $ref: '#/components/schemas/CreatedAt' + type: + type: string + enum: + - aws_role_delegation + config: + type: object + properties: + role_arn: + description: The Role ARN use for AWS Assume Role. + type: string + required: + - role_arn + title: AWSRoleDelegationAuthCredentialConfig + required: + - id + - integration_instance + - missing_permissions + - tainted + - expires_at + - created_at + - type + - config + title: AWSRoleDelegationAuthCredential MissingPermission: type: object properties: @@ -3513,6 +3593,25 @@ components: id: e0f2388b-2efe-42a3-a9e4-86f12d3e8c77 name: swaggerhub-internal display_name: SwaggerHub (Internal) + SampleCreateAWSRoleDelegationAuthPayload: + value: + type: aws_role_delegation + config: + role_arn: 'arn:aws:iam::084735895545:role/KonnectServiceCatalogRole' + SampleCreateAWSRoleDelegationAuthResponse: + value: + id: 4f535923-ec24-456c-b4e5-e67f65c8c208 + type: aws_role_delegation + missing_permissions: [] + tainted: false + expires_at: null + created_at: '2022-11-04T20:10:06.927Z' + integration_instance: + id: e0f2388b-2efe-42a3-a9e4-86f12d3e8c77 + name: swaggerhub-internal + display_name: SwaggerHub (Internal) + config: + role_arn: 'arn:aws:iam::084735895545:role/KonnectServiceCatalogRole' GitLabSelfManagedAuthConfigPayload: value: type: oauth @@ -3896,6 +3995,8 @@ components: $ref: '#/components/examples/SampleCreateDatadogMultiKeyAuthPayload' Traceable: $ref: '#/components/examples/SampleCreateTraceableMultiKeyAuthPayload' + AwsApiGateway: + $ref: '#/components/examples/SampleCreateAWSRoleDelegationAuthPayload' UpsertIntegrationInstanceAuthConfigRequest: required: true content: @@ -4042,6 +4143,8 @@ components: examples: SwaggerHub: $ref: '#/components/examples/SampleCreateSwaggerHubMultiKeyAuthResponse' + AwsApiGateway: + $ref: '#/components/examples/SampleCreateAWSRoleDelegationAuthResponse' IntegrationInstanceAuthConfigResponse: description: A response containing integration instance auth config. content: