diff --git a/openapi.yaml b/openapi.yaml index 15a115d..342cbd9 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -965,13 +965,14 @@ components: type: string format: uuid DocumentId: - name: documentId - in: path - required: true - description: Contains a unique identifier used by the Portal API for this resource. schema: type: string format: uuid + example: d32d905a-ed33-46a3-a093-d8f536af9a8a + name: documentId + in: path + required: true + description: ID of the document. FilterByAuthStrategyEquality: name: 'filter[auth_strategy_id][eq]' description: Filter by the id of the auth strategy supported by the application. @@ -1633,278 +1634,251 @@ components: example: 'kong:trace:1234567890' detail: example: Invalid credentials - AuthStrategyId: - description: 'ID of the auth strategy to use for the application. If null or not included, the default application auth strategy will be used.' + UUID: + description: Contains a unique identifier used by the API for this resource. type: string format: uuid - nullable: true - Scopes: - description: |- - **Pre-release Endpoint** - This endpoint is currently in beta and is subject to change. - - The granted scopes for the application. Will only be included if supported by the application's auth strategy. + example: 5f9fd312-a987-4628-b4c5-bb4f4fddd5f7 + readOnly: true + CreatedAt: + description: An ISO-8601 timestamp representation of entity creation date. + type: string + format: date-time + example: '2022-11-04T20:10:06.927Z' + readOnly: true + UpdatedAt: + description: An ISO-8601 timestamp representation of entity update date. + type: string + format: date-time + example: '2022-11-04T20:10:06.927Z' + readOnly: true + AvailableScopes: + description: Possible developer selectable scopes for an application. Only present when using DCR Provider that supports it. type: array items: type: string - CreateCredentialPayload: + example: + - scope1 + - scope2 + InvalidRules: + description: invalid parameters rules + type: string + enum: + - required + - is_array + - is_base64 + - is_boolean + - is_date_time + - is_integer + - is_null + - is_number + - is_object + - is_string + - is_uuid + - is_fqdn + - is_arn + - unknown_property + - missing_reference + - is_label + - matches_regex + - invalid + - is_supported_network_availability_zone_list + - is_supported_network_cidr_block + - is_supported_provider_region + nullable: true + readOnly: true + InvalidParameterStandard: type: object properties: - display_name: + field: type: string - maxLength: 255 - additionalProperties: false - UpdateCredentialPayload: - type: object - properties: - display_name: + example: name + readOnly: true + rule: + $ref: '#/components/schemas/InvalidRules' + source: type: string - maxLength: 255 - additionalProperties: false - required: - - display_name - ListApplicationsResponse: - type: object - properties: - meta: - $ref: '#/components/schemas/PaginatedMeta' - data: - type: array - items: - $ref: '#/components/schemas/GetApplicationResponse' + example: body + reason: + type: string + example: is a required field + readOnly: true additionalProperties: false required: - - data - - meta - GetApplicationResponse: + - field + - reason + InvalidParameterMinimumLength: type: object properties: - id: - $ref: '#/components/schemas/UUID' - name: + field: type: string - reference_id: - $ref: '#/components/schemas/ApplicationReferenceId' - description: + example: name + readOnly: true + rule: + description: invalid parameters rules type: string - nullable: true - redirect_uri: + enum: + - min_length + - min_digits + - min_lowercase + - min_uppercase + - min_symbols + - min_items + - min + nullable: false + readOnly: true + minimum: + type: integer + example: 8 + source: type: string - nullable: true - auth_strategy: - $ref: '#/components/schemas/PortalAuthStrategy' - scopes: - $ref: '#/components/schemas/Scopes' - created_at: - $ref: '#/components/schemas/CreatedAt' - updated_at: - $ref: '#/components/schemas/UpdatedAt' - additionalProperties: false - required: - - id - - name - - reference_id - - description - - updated_at - - created_at - ListCredentialsResponse: - type: object - properties: - meta: - $ref: '#/components/schemas/PaginatedMeta' - data: - type: array - items: - type: object - additionalProperties: false - properties: - id: - $ref: '#/components/schemas/UUID' - display_name: - type: string - required: - - id - - display_name + example: body + reason: + type: string + example: must have at least 8 characters + readOnly: true additionalProperties: false required: - - data - - meta - CredentialCreationResponse: + - field + - reason + - rule + - minimum + InvalidParameterMaximumLength: type: object properties: - credential: + field: type: string - id: - $ref: '#/components/schemas/UUID' - display_name: + example: name + readOnly: true + rule: + description: invalid parameters rules + type: string + enum: + - max_length + - max_items + - max + nullable: false + readOnly: true + maximum: + type: integer + example: 8 + source: + type: string + example: body + reason: type: string + example: must not have more than 8 characters + readOnly: true additionalProperties: false required: - - credential - - id - - display_name - RefreshTokenResponse: - description: Refresh token response + - field + - reason + - rule + - maximum + InvalidParameterChoiceItem: type: object properties: - client_id: + field: type: string - client_secret: + example: name + readOnly: true + rule: + description: invalid parameters rules + type: string + enum: + - enum + nullable: false + readOnly: true + reason: + type: string + example: is a required field + readOnly: true + choices: + type: array + items: {} + minItems: 1 + nullable: false + readOnly: true + uniqueItems: true + source: type: string + example: body additionalProperties: false required: - - client_id - - client_secret - title: Refresh token response - CreateApplicationPayload: - description: Application creation payload + - field + - reason + - rule + - choices + InvalidParameterDependentItem: type: object properties: - name: - description: The name of the application - type: string - maxLength: 255 - reference_id: - $ref: '#/components/schemas/ApplicationReferenceId' - redirect_uri: - description: URL to redirect to after completing an OIDC auth flow + field: type: string - format: uri - description: - description: A brief description of the application - type: string - maxLength: 255 - auth_strategy_id: - $ref: '#/components/schemas/AuthStrategyId' - scopes: - $ref: '#/components/schemas/Scopes' - additionalProperties: false - required: - - name - title: CreateApplicationPayload - ApplicationCreationResponse: - description: Application creation response payload - type: object - properties: - id: - $ref: '#/components/schemas/UUID' - name: - type: string - reference_id: - $ref: '#/components/schemas/ApplicationReferenceId' - description: - type: string - nullable: true - redirect_uri: + example: name + readOnly: true + rule: + description: invalid parameters rules type: string + enum: + - dependent_fields nullable: true - credentials: - type: object - additionalProperties: false - properties: - client_id: - type: string - client_secret: - type: string - required: - - client_id - - client_secret - auth_strategy: - $ref: '#/components/schemas/PortalAuthStrategy' - scopes: - $ref: '#/components/schemas/Scopes' - created_at: - $ref: '#/components/schemas/CreatedAt' - updated_at: - $ref: '#/components/schemas/UpdatedAt' - additionalProperties: false - required: - - id - - name - - reference_id - - description - - created_at - - updated_at - - auth_strategy - title: ApplicationCreationResponse - UpdateApplicationPayload: - description: Payload required to update an application - type: object - properties: - name: - description: The name of the application - type: string - maxLength: 255 - reference_id: - $ref: '#/components/schemas/ApplicationReferenceId' - redirect_uri: - description: URL to redirect to after completing an OIDC auth flow - type: string - format: uri - description: - description: A brief description of the application - type: string - maxLength: 255 - scopes: - $ref: '#/components/schemas/Scopes' - additionalProperties: false - title: UpdateApplicationPayload - ApplicationUpdateResponse: - description: Application update response payload - type: object - properties: - id: - $ref: '#/components/schemas/UUID' - name: - type: string - reference_id: - $ref: '#/components/schemas/ApplicationReferenceId' - description: + readOnly: true + reason: type: string - example: A brief description of the application + example: is a required field + readOnly: true + dependents: + type: array + items: {} nullable: true - redirect_uri: + readOnly: true + uniqueItems: true + source: type: string - example: 'https://example.com/callback' - nullable: true - auth_strategy: - $ref: '#/components/schemas/PortalAuthStrategy' - scopes: - $ref: '#/components/schemas/Scopes' - created_at: - $ref: '#/components/schemas/CreatedAt' - updated_at: - $ref: '#/components/schemas/UpdatedAt' - additionalProperties: false - required: - - id - - name - - reference_id - - description - - updated_at - - created_at - title: ApplicationUpdateResponse - GetGrantedScopesProductVersionResponse: - type: object - properties: - scopes: - $ref: '#/components/schemas/RefreshedGrantedScopes' - additionalProperties: false - required: - - scopes - ListAuthStrategiesResponse: - type: object - properties: - meta: - $ref: '#/components/schemas/PaginatedMeta' - data: - type: array - items: - $ref: '#/components/schemas/PortalAuthStrategy' + example: body additionalProperties: false required: - - data - - meta + - field + - rule + - reason + - dependents + InvalidParameters: + description: invalid parameters + type: array + items: + oneOf: + - $ref: '#/components/schemas/InvalidParameterStandard' + - $ref: '#/components/schemas/InvalidParameterMinimumLength' + - $ref: '#/components/schemas/InvalidParameterMaximumLength' + - $ref: '#/components/schemas/InvalidParameterChoiceItem' + - $ref: '#/components/schemas/InvalidParameterDependentItem' + minItems: 1 + nullable: false + uniqueItems: true + BadRequestError: + allOf: + - $ref: '#/components/schemas/BaseError' + - type: object + required: + - invalid_parameters + properties: + invalid_parameters: + $ref: '#/components/schemas/InvalidParameters' + NotFoundError: + allOf: + - $ref: '#/components/schemas/BaseError' + - type: object + properties: + status: + example: 404 + title: + example: Not Found + type: + example: 'https://httpstatuses.com/404' + instance: + example: 'kong:trace:1234567890' + detail: + example: Not found PageMeta: description: Contains pagination query parameters and the total number of objects returned. type: object @@ -1931,19 +1905,26 @@ components: required: - page title: PaginatedMeta - UUID: - description: Contains a unique identifier used by the API for this resource. + DocumentContentTypeEnum: + type: string + default: application/json + enum: + - application/json + - application/vnd.konnect.document-tree+json + DocumentFormatContentTypeEnum: + type: string + default: application/json + enum: + - text/markdown + - application/json + - application/vnd.konnect.document-nodes+json + NullableUUID: + description: Contains a unique identifier for a resource. type: string format: uuid example: 5f9fd312-a987-4628-b4c5-bb4f4fddd5f7 - readOnly: true - ApplicationReferenceId: - description: | - An identifier to correlate the application with an external system. - Cannot be set when using Dynamic Client Registration. - type: string - maxLength: 255 - PortalAuthStrategyKeyAuth: + nullable: true + AuthStrategyKeyAuth: description: KeyAuth Auth strategy that the application uses. type: object properties: @@ -1965,21 +1946,12 @@ components: type: array items: type: string - example: - - apikey + additionalProperties: false required: - id - name - credential_type - key_names - AvailableScopes: - description: Possible developer selectable scopes for an application. Only present when using DCR Provider that supports it. - type: array - items: - type: string - example: - - scope1 - - scope2 AuthMethods: type: array items: @@ -1987,7 +1959,7 @@ components: type: string example: - bearer - PortalAuthStrategyClientCredentials: + AuthStrategyClientCredentials: description: Client Credential Auth strategy that the application uses. type: object properties: @@ -1997,8 +1969,6 @@ components: format: uuid example: b9e81174-b5bb-4638-a3c3-8afe61a0abf8 readOnly: true - available_scopes: - $ref: '#/components/schemas/AvailableScopes' name: type: string example: name @@ -2010,249 +1980,226 @@ components: - self_managed_client_credentials auth_methods: $ref: '#/components/schemas/AuthMethods' + available_scopes: + $ref: '#/components/schemas/AvailableScopes' + additionalProperties: false required: - id - name - credential_type - auth_methods - PortalAuthStrategy: + AuthStrategy: type: object discriminator: propertyName: credential_type - nullable: true oneOf: - - $ref: '#/components/schemas/PortalAuthStrategyKeyAuth' - - $ref: '#/components/schemas/PortalAuthStrategyClientCredentials' - CreatedAt: - description: An ISO-8601 timestamp representation of entity creation date. - type: string - format: date-time - example: '2022-11-04T20:10:06.927Z' - readOnly: true - UpdatedAt: - description: An ISO-8601 timestamp representation of entity update date. + - $ref: '#/components/schemas/AuthStrategyKeyAuth' + - $ref: '#/components/schemas/AuthStrategyClientCredentials' + ApplicationReferenceId: + description: | + An identifier to correlate the application with an external system. + Cannot be set when using Dynamic Client Registration. type: string - format: date-time - example: '2022-11-04T20:10:06.927Z' - readOnly: true - InvalidRules: - description: invalid parameters rules - type: string - enum: - - required - - is_array - - is_base64 - - is_boolean - - is_date_time - - is_integer - - is_null - - is_number - - is_object - - is_string - - is_uuid - - is_fqdn - - is_arn - - unknown_property - - is_label - - matches_regex - - invalid - - is_supported_network_availability_zone_list - - is_supported_network_cidr_block - - is_supported_provider_region - nullable: true - readOnly: true - InvalidParameterStandard: + maxLength: 255 + PortalAuthStrategyKeyAuth: + description: KeyAuth Auth strategy that the application uses. type: object properties: - field: + id: + description: The Application Auth Strategy ID. type: string - example: name + format: uuid + example: b9e81174-b5bb-4638-a3c3-8afe61a0abf8 readOnly: true - rule: - $ref: '#/components/schemas/InvalidRules' - source: + name: type: string - example: body - reason: + example: name + default: name + credential_type: type: string - example: is a required field - readOnly: true - additionalProperties: false + enum: + - key_auth + key_names: + type: array + items: + type: string + example: + - apikey required: - - field - - reason - InvalidParameterMinimumLength: + - id + - name + - credential_type + - key_names + PortalAuthStrategyClientCredentials: + description: Client Credential Auth strategy that the application uses. type: object properties: - field: - type: string - example: name - readOnly: true - rule: - description: invalid parameters rules + id: + description: The Application Auth Strategy ID. type: string - enum: - - min_length - - min_digits - - min_lowercase - - min_uppercase - - min_symbols - - min_items - - min - nullable: false + format: uuid + example: b9e81174-b5bb-4638-a3c3-8afe61a0abf8 readOnly: true - minimum: - type: integer - example: 8 - source: + available_scopes: + $ref: '#/components/schemas/AvailableScopes' + name: type: string - example: body - reason: + example: name + default: name + credential_type: type: string - example: must have at least 8 characters - readOnly: true - additionalProperties: false + enum: + - client_credentials + - self_managed_client_credentials + auth_methods: + $ref: '#/components/schemas/AuthMethods' required: - - field - - reason - - rule - - minimum - InvalidParameterMaximumLength: + - id + - name + - credential_type + - auth_methods + PortalAuthStrategy: + type: object + discriminator: + propertyName: credential_type + oneOf: + - $ref: '#/components/schemas/PortalAuthStrategyKeyAuth' + - $ref: '#/components/schemas/PortalAuthStrategyClientCredentials' + Scopes: + description: |- + **Pre-release Endpoint** + This endpoint is currently in beta and is subject to change. + + The granted scopes for the application. Will only be included if supported by the application's auth strategy. + type: array + items: + type: string + GetApplicationResponse: type: object properties: - field: - type: string - example: name - readOnly: true - rule: - description: invalid parameters rules + id: + $ref: '#/components/schemas/UUID' + name: type: string - enum: - - max_length - - max_items - - max - nullable: false - readOnly: true - maximum: - type: integer - example: 8 - source: + reference_id: + $ref: '#/components/schemas/ApplicationReferenceId' + description: type: string - example: body - reason: + nullable: true + redirect_uri: type: string - example: must not have more than 8 characters - readOnly: true + nullable: true + auth_strategy: + $ref: '#/components/schemas/PortalAuthStrategy' + scopes: + $ref: '#/components/schemas/Scopes' + created_at: + $ref: '#/components/schemas/CreatedAt' + updated_at: + $ref: '#/components/schemas/UpdatedAt' + client_id: + $ref: '#/components/schemas/ApplicationClientId' additionalProperties: false required: - - field - - reason - - rule - - maximum - InvalidParameterChoiceItem: + - id + - name + - reference_id + - description + - updated_at + - created_at + ListApplicationsResponse: type: object properties: - field: - type: string - example: name - readOnly: true - rule: - description: invalid parameters rules + meta: + $ref: '#/components/schemas/PaginatedMeta' + data: + type: array + items: + $ref: '#/components/schemas/GetApplicationResponse' + additionalProperties: false + required: + - data + - meta + AuthStrategyId: + description: 'ID of the auth strategy to use for the application. If null or not included, the default application auth strategy will be used.' + type: string + format: uuid + nullable: true + CreateApplicationPayload: + description: Application creation payload + type: object + properties: + name: + description: The name of the application type: string - enum: - - enum - nullable: false - readOnly: true - reason: + maxLength: 255 + reference_id: + $ref: '#/components/schemas/ApplicationReferenceId' + redirect_uri: + description: URL to redirect to after completing an OIDC auth flow type: string - example: is a required field - readOnly: true - choices: - type: array - items: {} - minItems: 1 - nullable: false - readOnly: true - uniqueItems: true - source: + format: uri + description: + description: A brief description of the application type: string - example: body + maxLength: 255 + auth_strategy_id: + $ref: '#/components/schemas/AuthStrategyId' + scopes: + $ref: '#/components/schemas/Scopes' + client_id: + $ref: '#/components/schemas/ApplicationClientId' additionalProperties: false required: - - field - - reason - - rule - - choices - InvalidParameterDependentItem: + - name + title: CreateApplicationPayload + ApplicationCreationResponse: + description: Application creation response payload type: object properties: - field: + id: + $ref: '#/components/schemas/UUID' + name: type: string - example: name - readOnly: true - rule: - description: invalid parameters rules + reference_id: + $ref: '#/components/schemas/ApplicationReferenceId' + description: type: string - enum: - - dependent_fields nullable: true - readOnly: true - reason: + redirect_uri: type: string - example: is a required field - readOnly: true - dependents: - type: array - items: {} nullable: true - readOnly: true - uniqueItems: true - source: - type: string - example: body + credentials: + type: object + additionalProperties: false + properties: + client_id: + type: string + client_secret: + type: string + required: + - client_id + - client_secret + auth_strategy: + $ref: '#/components/schemas/PortalAuthStrategy' + scopes: + $ref: '#/components/schemas/Scopes' + created_at: + $ref: '#/components/schemas/CreatedAt' + updated_at: + $ref: '#/components/schemas/UpdatedAt' + client_id: + $ref: '#/components/schemas/ApplicationClientId' additionalProperties: false required: - - field - - rule - - reason - - dependents - InvalidParameters: - description: invalid parameters - type: array - items: - oneOf: - - $ref: '#/components/schemas/InvalidParameterStandard' - - $ref: '#/components/schemas/InvalidParameterMinimumLength' - - $ref: '#/components/schemas/InvalidParameterMaximumLength' - - $ref: '#/components/schemas/InvalidParameterChoiceItem' - - $ref: '#/components/schemas/InvalidParameterDependentItem' - minItems: 1 - nullable: false - uniqueItems: true - BadRequestError: - allOf: - - $ref: '#/components/schemas/BaseError' - - type: object - required: - - invalid_parameters - properties: - invalid_parameters: - $ref: '#/components/schemas/InvalidParameters' - NotFoundError: - allOf: - - $ref: '#/components/schemas/BaseError' - - type: object - properties: - status: - example: 404 - title: - example: Not Found - type: - example: 'https://httpstatuses.com/404' - instance: - example: 'kong:trace:1234567890' - detail: - example: Not found + - id + - name + - reference_id + - description + - created_at + - updated_at + - auth_strategy + title: ApplicationCreationResponse ConflictError: allOf: - $ref: '#/components/schemas/BaseError' @@ -2283,11 +2230,145 @@ components: example: 'kong:trace:1234567890' detail: example: Too Many Requests + UpdateApplicationPayload: + description: Payload required to update an application + type: object + properties: + name: + description: The name of the application + type: string + maxLength: 255 + reference_id: + $ref: '#/components/schemas/ApplicationReferenceId' + redirect_uri: + description: URL to redirect to after completing an OIDC auth flow + type: string + format: uri + description: + description: A brief description of the application + type: string + maxLength: 255 + scopes: + $ref: '#/components/schemas/Scopes' + client_id: + $ref: '#/components/schemas/ApplicationClientId' + additionalProperties: false + title: UpdateApplicationPayload + ApplicationUpdateResponse: + description: Application update response payload + type: object + properties: + id: + $ref: '#/components/schemas/UUID' + name: + type: string + reference_id: + $ref: '#/components/schemas/ApplicationReferenceId' + description: + type: string + example: A brief description of the application + nullable: true + redirect_uri: + type: string + example: 'https://example.com/callback' + nullable: true + auth_strategy: + $ref: '#/components/schemas/PortalAuthStrategy' + scopes: + $ref: '#/components/schemas/Scopes' + created_at: + $ref: '#/components/schemas/CreatedAt' + updated_at: + $ref: '#/components/schemas/UpdatedAt' + client_id: + $ref: '#/components/schemas/ApplicationClientId' + additionalProperties: false + required: + - id + - name + - reference_id + - description + - updated_at + - created_at + title: ApplicationUpdateResponse + RefreshTokenResponse: + description: Refresh token response + type: object + properties: + client_id: + type: string + client_secret: + type: string + additionalProperties: false + required: + - client_id + - client_secret + title: Refresh token response + ListCredentialsResponse: + type: object + properties: + meta: + $ref: '#/components/schemas/PaginatedMeta' + data: + type: array + items: + type: object + additionalProperties: false + properties: + id: + $ref: '#/components/schemas/UUID' + display_name: + type: string + required: + - id + - display_name + additionalProperties: false + required: + - data + - meta + CreateCredentialPayload: + type: object + properties: + display_name: + type: string + maxLength: 255 + additionalProperties: false + CredentialCreationResponse: + type: object + properties: + credential: + type: string + id: + $ref: '#/components/schemas/UUID' + display_name: + type: string + additionalProperties: false + required: + - credential + - id + - display_name + UpdateCredentialPayload: + type: object + properties: + display_name: + type: string + maxLength: 255 + additionalProperties: false + required: + - display_name RefreshedGrantedScopes: description: 'List of granted scopes, directly updated from the IDP' type: array items: type: string + GetGrantedScopesProductVersionResponse: + type: object + properties: + scopes: + $ref: '#/components/schemas/RefreshedGrantedScopes' + additionalProperties: false + required: + - scopes UnprocessableContentError: allOf: - $ref: '#/components/schemas/BaseError' @@ -2303,6 +2384,25 @@ components: example: 'kong:trace:1234567891' detail: example: Unprocessable Content + ListAuthStrategiesResponse: + type: object + properties: + meta: + $ref: '#/components/schemas/PaginatedMeta' + data: + type: array + items: + $ref: '#/components/schemas/PortalAuthStrategy' + additionalProperties: false + required: + - data + - meta + ApplicationClientId: + description: | + An identifier to correlate the application with an external system. + Cannot be set when using Dynamic Client Registration. + type: string + maxLength: 255 AuthenticateRequest: description: The request schema for the authenticate endpoint. type: object @@ -2912,73 +3012,6 @@ components: maxLength: 63 maxProperties: 50 title: PublicLabels - NullableUUID: - description: Contains a unique identifier for a resource. - type: string - format: uuid - example: 5f9fd312-a987-4628-b4c5-bb4f4fddd5f7 - nullable: true - AuthStrategyKeyAuth: - description: KeyAuth Auth strategy that the application uses. - type: object - properties: - id: - description: The Application Auth Strategy ID. - type: string - format: uuid - example: b9e81174-b5bb-4638-a3c3-8afe61a0abf8 - readOnly: true - name: - type: string - example: name - default: name - credential_type: - type: string - enum: - - key_auth - required: - - id - - name - - credential_type - AuthStrategyClientCredentials: - description: Client Credential Auth strategy that the application uses. - type: object - properties: - id: - description: The Application Auth Strategy ID. - type: string - format: uuid - example: b9e81174-b5bb-4638-a3c3-8afe61a0abf8 - readOnly: true - name: - type: string - example: name - default: name - credential_type: - type: string - enum: - - client_credentials - - self_managed_client_credentials - auth_methods: - $ref: '#/components/schemas/AuthMethods' - required: - - id - - name - - credential_type - - auth_methods - AuthStrategy: - type: object - discriminator: - propertyName: credential_type - oneOf: - - $ref: '#/components/schemas/AuthStrategyKeyAuth' - - $ref: '#/components/schemas/AuthStrategyClientCredentials' - DocumentContentTypeEnum: - type: string - default: application/json - enum: - - application/json - - application/vnd.konnect.document-tree+json Metadata: description: Contains key value pairs information about entity's metadata. type: object @@ -3082,13 +3115,6 @@ components: required: - meta - data - DocumentFormatContentTypeEnum: - type: string - default: application/json - enum: - - text/markdown - - application/json - - application/vnd.konnect.document-nodes+json NodeChildren: description: List of children nodes of the current node type: array @@ -3808,6 +3834,18 @@ components: title: Forbidden instance: 'kong:trace:2723154947768991354' detail: You do not have permission to perform this action + NotFoundExample: + value: + status: 404 + title: Not Found + instance: 'kong:trace:6816496025408232265' + detail: Not Found + PostCredentials403Example: + value: + status: 403 + title: Forbidden + detail: 'Maximum number of Credentials exceeded. Max Allowed: 20' + instance: 'kong:trace:2724154947768991355' GetGrantedScopesProductVersion200Response: value: scopes: @@ -3819,18 +3857,6 @@ components: type: 'https://kongapi.info/konnect/portal/granted-scopes-unavailable' detail: This feature is not supported by the application. instance: 'kong:trace:2724154947768991354' - PostCredentials403Example: - value: - status: 403 - title: Forbidden - detail: 'Maximum number of Credentials exceeded. Max Allowed: 20' - instance: 'kong:trace:2724154947768991355' - NotFoundExample: - value: - status: 404 - title: Not Found - instance: 'kong:trace:6816496025408232265' - detail: Not Found Authenticate-Request: value: username: developer@example.com @@ -4044,18 +4070,70 @@ components: $ref: '#/components/examples/401-Unauthorized' 401-Account-Not-Approved: $ref: '#/components/examples/401-Account-Not-Approved' + BadRequest: + description: Bad Request + content: + application/problem+json: + schema: + $ref: '#/components/schemas/BadRequestError' + examples: + 400-Invalid-Token: + $ref: '#/components/examples/400-Invalid-Token' + 400-Login-Failed: + $ref: '#/components/examples/400-Login-Failed' + NotFound: + description: Not Found + content: + application/problem+json: + schema: + $ref: '#/components/schemas/NotFoundError' + examples: + NotFoundExample: + $ref: '#/components/examples/NotFoundExample' + 404-Token-Not-Found: + $ref: '#/components/examples/404-Token-Not-Found' + NotAvailable: + description: Service not available + content: + application/problem+json: + schema: + $ref: '#/components/schemas/BaseError' ListApplications: description: Get applications response content: application/json: schema: $ref: '#/components/schemas/ListApplicationsResponse' + ApplicationCreation: + description: Application Creation success + content: + application/json: + schema: + $ref: '#/components/schemas/ApplicationCreationResponse' + Conflict: + description: Conflict + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ConflictError' GetApplication: description: Get application response content: application/json: schema: $ref: '#/components/schemas/GetApplicationResponse' + TooManyRequests: + description: Too Many Requests + content: + application/problem+json: + schema: + $ref: '#/components/schemas/TooManyRequestsError' + ApplicationUpdate: + description: Application Update success + content: + application/json: + schema: + $ref: '#/components/schemas/ApplicationUpdateResponse' RefreshToken: description: Refresh token response content: @@ -4074,18 +4152,15 @@ components: application/json: schema: $ref: '#/components/schemas/CredentialCreationResponse' - ApplicationCreation: - description: Application Creation success - content: - application/json: - schema: - $ref: '#/components/schemas/ApplicationCreationResponse' - ApplicationUpdate: - description: Application Update success + PostCredentials403Response: + description: Error returned when the number of credentials exceed the quota. content: - application/json: + application/problem+json: schema: - $ref: '#/components/schemas/ApplicationUpdateResponse' + $ref: '#/components/schemas/ForbiddenError' + examples: + PostCredentials403Example: + $ref: '#/components/examples/PostCredentials403Example' GetGrantedScopesProductVersion: description: Get granted scopes response. content: @@ -4104,55 +4179,12 @@ components: examples: GetGrantedScopesProductVersion422Example: $ref: '#/components/examples/GetGrantedScopesProductVersion422Example' - PostCredentials403Response: - description: Error returned when the number of credentials exceed the quota. - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ForbiddenError' - examples: - PostCredentials403Example: - $ref: '#/components/examples/PostCredentials403Example' ListAuthStrategies: description: List auth strategies response content: application/json: schema: $ref: '#/components/schemas/ListAuthStrategiesResponse' - BadRequest: - description: Bad Request - content: - application/problem+json: - schema: - $ref: '#/components/schemas/BadRequestError' - examples: - 400-Invalid-Token: - $ref: '#/components/examples/400-Invalid-Token' - 400-Login-Failed: - $ref: '#/components/examples/400-Login-Failed' - NotFound: - description: Not Found - content: - application/problem+json: - schema: - $ref: '#/components/schemas/NotFoundError' - examples: - NotFoundExample: - $ref: '#/components/examples/NotFoundExample' - 404-Token-Not-Found: - $ref: '#/components/examples/404-Token-Not-Found' - Conflict: - description: Conflict - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ConflictError' - TooManyRequests: - description: Too Many Requests - content: - application/problem+json: - schema: - $ref: '#/components/schemas/TooManyRequestsError' Gone: description: Gone content: @@ -4280,12 +4312,6 @@ components: application/vnd.konnect.document-nodes+json: schema: $ref: '#/components/schemas/ProductDocument' - NotAvailable: - description: Service not available - content: - application/problem+json: - schema: - $ref: '#/components/schemas/BaseError' CreateRegistration: description: Registration creation response. content: @@ -4351,7 +4377,7 @@ tags: - name: versions description: The API for Konnect Portal Product Versions. - name: documentation - description: The API for Konnect Portal Product Documentation. + description: The API for Konnect Portal API Documentation. - name: registrations description: | The API for Konnect Portal application registrations. If the portal is public