---
title: "Konnect API Catalog"
url: "https://nov18-dev.movespot.fyi/apis/konnect-api-catalog-3/versions/b74d7c76-ffb8-4e47-b70c-11184b8918a6"
---

# Konnect API Catalog

OpenAPI specification document.

```json
{"openapi":"3.0.3","info":{"title":"Konnect API Catalog","version":"3.1.1","description":"The management API for creating, managing APIs in the Konnect API Catalog, and publishing APIs in Dev Portals.","contact":{"name":"Kong","url":"https://cloud.konghq.com"}},"servers":[{"url":"https://us.api.konghq.com/v3","description":"United-States Production region"},{"url":"https://eu.api.konghq.com/v3","description":"Europe Production region"},{"url":"https://au.api.konghq.com/v3","description":"Australia Production region"},{"url":"https://me.api.konghq.com/v3","description":"Middle-East Production region"},{"url":"https://in.api.konghq.com/v3","description":"India Production region"},{"url":"https://sg.api.konghq.com/v3","description":"Singapore Production region"}],"paths":{"/apis":{"post":{"operationId":"create-api","summary":"Create API","description":"Creates an API.","requestBody":{"$ref":"#/components/requestBodies/CreateApiRequest"},"responses":{"201":{"$ref":"#/components/responses/ApiResponse"},"400":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"},"examples":{"ApiNameBadRequestExample":{"$ref":"#/components/examples/ApiNameBadRequestExample"}}}}},"401":{"$ref":"#/components/responses/ApiUnauthorized"},"403":{"$ref":"#/components/responses/ApiForbidden"},"404":{"$ref":"#/components/responses/ApiNotFound"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"}},"tags":["API"]},"get":{"operationId":"list-apis","summary":"List APIs","description":"Returns a collection of all APIs.","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"},{"$ref":"#/components/parameters/ApiFilters"},{"$ref":"#/components/parameters/ApiSort"}],"responses":{"200":{"$ref":"#/components/responses/ListApiResponse"},"400":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"},"examples":{"InvalidApiSortQueryBadRequestExample":{"$ref":"#/components/examples/InvalidApiSortQueryNameBadRequestExample"}}}}},"401":{"$ref":"#/components/responses/ApiUnauthorized"},"403":{"$ref":"#/components/responses/ApiForbidden"},"404":{"$ref":"#/components/responses/ApiNotFound"}},"tags":["API"]}},"/apis/validate-specification":{"post":{"operationId":"validate-specification","summary":"Validate API Specification","description":"Validates the content and type (OpenAPI or AsyncAPI) of a potential API specification without associating it with a specific API.","requestBody":{"$ref":"#/components/requestBodies/ValidateApiSpecRequest"},"responses":{"201":{"$ref":"#/components/responses/ValidateApiSpecSuccessResponse"},"400":{"description":"Bad Request - Either the request format is invalid or the specification content failed validation.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"},"examples":{"ApiSpecContentBadRequestExample":{"$ref":"#/components/examples/ApiSpecContentBadRequestExample"},"ApiSpecValidationFailedBadRequestExample":{"$ref":"#/components/examples/ValidateApiSpecBadRequestExample"}}}}},"401":{"$ref":"#/components/responses/ApiUnauthorized"},"403":{"$ref":"#/components/responses/ApiForbidden"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"}},"tags":["API Specification"]}},"/apis/{apiId}":{"parameters":[{"name":"apiId","in":"path","description":"The UUID API identifier","required":true,"schema":{"type":"string","format":"uuid","example":"9f5061ce-78f6-4452-9108-ad7c02821fd5"}}],"get":{"operationId":"fetch-api","summary":"Get an API","description":"Get an API.","responses":{"200":{"$ref":"#/components/responses/ApiResponse"},"401":{"$ref":"#/components/responses/ApiUnauthorized"},"403":{"$ref":"#/components/responses/ApiForbidden"},"404":{"$ref":"#/components/responses/ApiNotFound"}},"tags":["API"]},"patch":{"operationId":"update-api","summary":"Update API","description":"Updates an API.","parameters":[{"name":"force","in":"query","description":"If true, allows operations to be removed from the current version when using access control enforcement.\nIf false, operations removal will be rejected with a 409 error.\nOmitting the value means true.\n","schema":{"type":"string","default":"false","enum":["true","false"]}}],"requestBody":{"$ref":"#/components/requestBodies/UpdateApiRequest"},"responses":{"200":{"$ref":"#/components/responses/ApiResponse"},"400":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"},"examples":{"ApiNameBadRequestExample":{"$ref":"#/components/examples/ApiNameBadRequestExample"}}}}},"401":{"$ref":"#/components/responses/ApiUnauthorized"},"403":{"$ref":"#/components/responses/ApiForbidden"},"404":{"$ref":"#/components/responses/ApiNotFound"},"409":{"$ref":"#/components/responses/ApiVersionPatchConflict"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"}},"tags":["API"]},"delete":{"operationId":"delete-api","summary":"Delete API","description":"Deletes an API.","responses":{"204":{"description":"API was deleted successfully."},"401":{"$ref":"#/components/responses/ApiUnauthorized"},"403":{"$ref":"#/components/responses/ApiForbidden"},"404":{"$ref":"#/components/responses/ApiNotFound"}},"tags":["API"]}},"/apis/{apiId}/documents":{"parameters":[{"$ref":"#/components/parameters/ApiId"}],"post":{"operationId":"create-api-document","summary":"Create API Document","description":"Publish a new document attached to an API.\n\nAll configuration options may be provided in the frontmatter section of `content`. If you set values in both the `POST` request _and_ in the frontmatter, the values in the `POST` request will take precedence.\n","requestBody":{"$ref":"#/components/requestBodies/CreateApiDocumentRequest"},"responses":{"201":{"$ref":"#/components/responses/ApiDocumentResponse"},"400":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"},"examples":{"ApiNameBadRequestExample":{"$ref":"#/components/examples/ApiDocumentBadRequestExample"}}}}},"401":{"$ref":"#/components/responses/ApiUnauthorized"},"403":{"$ref":"#/components/responses/ApiForbidden"},"404":{"$ref":"#/components/responses/ApiNotFound"},"409":{"$ref":"#/components/responses/ApiSlugConflict"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"}},"tags":["API Documentation"]},"get":{"operationId":"list-api-documents","summary":"List API Documents","description":"Returns a collection of all documents for an API.","parameters":[{"$ref":"#/components/parameters/ApiDocumentFilters"}],"responses":{"200":{"$ref":"#/components/responses/ListApiDocumentResponse"},"400":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"},"examples":{"InvalidApiSortQueryBadRequestExample":{"$ref":"#/components/examples/InvalidApiSortQueryBadRequestExample"}}}}},"401":{"$ref":"#/components/responses/ApiUnauthorized"},"403":{"$ref":"#/components/responses/ApiForbidden"},"404":{"$ref":"#/components/responses/ApiNotFound"}},"tags":["API Documentation"]}},"/apis/{apiId}/documents/{documentId}":{"parameters":[{"$ref":"#/components/parameters/ApiId"},{"$ref":"#/components/parameters/DocumentId"}],"get":{"operationId":"fetch-api-document","summary":"Get an API Document","description":"Returns a document for the API.","responses":{"200":{"$ref":"#/components/responses/ApiDocumentResponse"},"401":{"$ref":"#/components/responses/ApiUnauthorized"},"403":{"$ref":"#/components/responses/ApiForbidden"},"404":{"$ref":"#/components/responses/ApiNotFound"}},"tags":["API Documentation"]},"patch":{"operationId":"update-api-document","summary":"Update API Document","description":"Updates a document for an API.","requestBody":{"$ref":"#/components/requestBodies/UpdateApiDocumentRequest"},"responses":{"200":{"$ref":"#/components/responses/ApiDocumentResponse"},"400":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"},"examples":{"ApiNameBadRequestExample":{"$ref":"#/components/examples/ApiDocumentBadRequestExample"}}}}},"401":{"$ref":"#/components/responses/ApiUnauthorized"},"403":{"$ref":"#/components/responses/ApiForbidden"},"404":{"$ref":"#/components/responses/ApiNotFound"},"409":{"$ref":"#/components/responses/ApiSlugConflict"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"}},"tags":["API Documentation"]},"delete":{"operationId":"delete-api-document","summary":"Delete API Documentation","description":"Removes a document from an API.","responses":{"204":{"description":"Document for the API was deleted successfully."},"401":{"$ref":"#/components/responses/ApiUnauthorized"},"403":{"$ref":"#/components/responses/ApiForbidden"},"404":{"$ref":"#/components/responses/ApiNotFound"}},"tags":["API Documentation"]}},"/apis/{apiId}/documents/{documentId}/move":{"parameters":[{"$ref":"#/components/parameters/ApiId"},{"$ref":"#/components/parameters/DocumentId"}],"post":{"operationId":"move-api-document","summary":"Move API Documentation","description":"This api allows the user to move a document within the document tree using the parameters parent_document_id and index. If parent_document_id is not provided, the document will be placed at the top level of the document tree. index represents a zero-indexed document order relative to its siblings under the same parent. For example, if we want to put the document at top level in first position we would send parent_document_id: null and index: 0. This api also supports using a negative index to count backwards from the end of the document list, which means you can put the document in last position by using index: -1.","requestBody":{"$ref":"#/components/requestBodies/MoveDocumentRequest"},"responses":{"204":{"description":"Document for the API was moved successfully."},"401":{"$ref":"#/components/responses/ApiUnauthorized"},"403":{"$ref":"#/components/responses/ApiForbidden"},"404":{"$ref":"#/components/responses/ApiNotFound"},"409":{"$ref":"#/components/responses/Conflict"}},"tags":["API Documentation"]}},"/apis/{apiId}/specifications":{"parameters":[{"$ref":"#/components/parameters/ApiId"}],"post":{"operationId":"create-api-spec","summary":"Create API Specification","description":"Creates a specification (OpenAPI or AsyncAPI) for an API.\n**Note:** You can only have one specification for an API. This endpoint is deprecated and will be removed: use /versions instead.\n","requestBody":{"$ref":"#/components/requestBodies/CreateApiSpecRequest"},"responses":{"201":{"$ref":"#/components/responses/ApiSpecResponse"},"400":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"},"examples":{"ApiSpecContentBadRequestExample":{"$ref":"#/components/examples/ApiSpecContentBadRequestExample"}}}}},"401":{"$ref":"#/components/responses/ApiUnauthorized"},"403":{"$ref":"#/components/responses/ApiForbidden"},"404":{"$ref":"#/components/responses/ApiNotFound"},"409":{"$ref":"#/components/responses/ApiSpecConflict"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"}},"deprecated":true,"tags":["API Specification"]},"get":{"operationId":"list-api-specs","summary":"List API Specifications","description":"Returns a list of specifications for an API. The specification can be of type OpenAPI or AsyncAPI.\n**Note:** You can only have one specification for an API. This endpoint is deprecated and will be removed: use /versions instead.\n","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"},{"$ref":"#/components/parameters/ApiSpecFilters"}],"responses":{"200":{"$ref":"#/components/responses/ListApiSpecResponse"},"401":{"$ref":"#/components/responses/ApiUnauthorized"},"403":{"$ref":"#/components/responses/ApiForbidden"},"404":{"$ref":"#/components/responses/ApiNotFound"}},"deprecated":true,"tags":["API Specification"]}},"/apis/{apiId}/specifications/{specId}":{"parameters":[{"$ref":"#/components/parameters/ApiId"},{"$ref":"#/components/parameters/SpecId"}],"get":{"operationId":"fetch-api-spec","summary":"Get API Specification","description":"Fetches the specification (OpenAPI or AsyncAPI) of an API.\n**Note:** This endpoint is deprecated and will be removed: use /versions instead.\n","responses":{"200":{"$ref":"#/components/responses/ApiSpecResponse"},"401":{"$ref":"#/components/responses/ApiUnauthorized"},"403":{"$ref":"#/components/responses/ApiForbidden"},"404":{"$ref":"#/components/responses/ApiNotFound"}},"deprecated":true,"tags":["API Specification"]},"patch":{"operationId":"update-api-spec","summary":"Update API Specification","description":"Updates the specification (OpenAPI or AsyncAPI) of an API.\n**Note:** This endpoint is deprecated and will be removed: use /versions instead.\n","requestBody":{"$ref":"#/components/requestBodies/UpdateApiSpecRequest"},"responses":{"200":{"$ref":"#/components/responses/ApiSpecResponse"},"400":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"},"examples":{"ApiSpecContentBadRequestExample":{"$ref":"#/components/examples/ApiSpecContentBadRequestExample"}}}}},"401":{"$ref":"#/components/responses/ApiUnauthorized"},"403":{"$ref":"#/components/responses/ApiForbidden"},"404":{"$ref":"#/components/responses/ApiNotFound"},"409":{"$ref":"#/components/responses/ApiSpecHiddenConflict"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"}},"deprecated":true,"tags":["API Specification"]},"delete":{"operationId":"delete-api-spec","summary":"Delete API Specification","description":"Deletes the specification (OpenAPI or AsyncAPI) of an API.\n**Note:** This endpoint is deprecated and will be removed: use /versions instead.\n","responses":{"204":{"description":"API Specification was deleted successfully."},"401":{"$ref":"#/components/responses/ApiUnauthorized"},"403":{"$ref":"#/components/responses/ApiForbidden"},"404":{"$ref":"#/components/responses/ApiNotFound"}},"deprecated":true,"tags":["API Specification"]}},"/apis/{apiId}/versions":{"parameters":[{"$ref":"#/components/parameters/ApiId"}],"post":{"operationId":"create-api-version","summary":"Create API Version","description":"Creates a version (OpenAPI or AsyncAPI) for an API.\n","requestBody":{"$ref":"#/components/requestBodies/CreateApiVersionRequest"},"responses":{"201":{"$ref":"#/components/responses/ApiVersionResponse"},"400":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"},"examples":{"ApiVersionBadRequestExample":{"$ref":"#/components/examples/ApiVersionBadRequestExample"}}}}},"401":{"$ref":"#/components/responses/ApiUnauthorized"},"403":{"$ref":"#/components/responses/ApiForbidden"},"404":{"$ref":"#/components/responses/ApiNotFound"},"409":{"$ref":"#/components/responses/ApiSpecConflict"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"}},"tags":["API Version"]},"get":{"operationId":"list-api-versions","summary":"List API Versions","description":"Returns a list of versions for an API. The version can be of type OpenAPI or AsyncAPI.\n**Note:** You can only have one version for an API.\n","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"},{"$ref":"#/components/parameters/ApiVersionFilters"},{"$ref":"#/components/parameters/ApiVersionSort"}],"responses":{"200":{"$ref":"#/components/responses/ListApiVersionResponse"},"401":{"$ref":"#/components/responses/ApiUnauthorized"},"403":{"$ref":"#/components/responses/ApiForbidden"},"404":{"$ref":"#/components/responses/ApiNotFound"}},"tags":["API Version"]}},"/apis/{apiId}/versions/{versionId}":{"parameters":[{"$ref":"#/components/parameters/ApiId"},{"$ref":"#/components/parameters/VersionId"}],"get":{"operationId":"fetch-api-version","summary":"Get an API Version","description":"Fetches the version (OpenAPI or AsyncAPI) of an API.","responses":{"200":{"$ref":"#/components/responses/ApiVersionResponse"},"401":{"$ref":"#/components/responses/ApiUnauthorized"},"403":{"$ref":"#/components/responses/ApiForbidden"},"404":{"$ref":"#/components/responses/ApiNotFound"}},"tags":["API Version"]},"patch":{"operationId":"update-api-version","summary":"Update API Version","description":"Updates the version (OpenAPI or AsyncAPI) of an API.","parameters":[{"name":"force","in":"query","description":"If true, allows operations to be removed from the current version when using access control enforcement.\nIf false, operations removal will be rejected with a 409 error.\nOmitting the value (i.e., setting `?force`) means true.\n","schema":{"type":"string","default":"false","enum":["true","false"]}}],"requestBody":{"$ref":"#/components/requestBodies/UpdateApiVersionRequest"},"responses":{"200":{"$ref":"#/components/responses/ApiVersionResponse"},"400":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"},"examples":{"ApiVersionBadRequestExample":{"$ref":"#/components/examples/ApiVersionBadRequestExample"}}}}},"401":{"$ref":"#/components/responses/ApiUnauthorized"},"403":{"$ref":"#/components/responses/ApiForbidden"},"404":{"$ref":"#/components/responses/ApiNotFound"},"409":{"$ref":"#/components/responses/ApiVersionPatchConflict"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"}},"tags":["API Version"]},"delete":{"operationId":"delete-api-version","summary":"Delete API Version","description":"Deletes the version (OpenAPI or AsyncAPI) of an API.","responses":{"204":{"description":"API Version was deleted successfully."},"401":{"$ref":"#/components/responses/ApiUnauthorized"},"403":{"$ref":"#/components/responses/ApiForbidden"},"404":{"$ref":"#/components/responses/ApiNotFound"}},"tags":["API Version"]}},"/apis/{apiId}/publications/{portalId}":{"parameters":[{"$ref":"#/components/parameters/ApiId"},{"$ref":"#/components/parameters/PortalId"}],"put":{"operationId":"publish-api-to-portal","summary":"Publish API","description":"Publish an API to a portal.\n","requestBody":{"$ref":"#/components/requestBodies/PutApiPublicationRequest"},"responses":{"200":{"$ref":"#/components/responses/ApiPublicationResponse"},"400":{"$ref":"#/components/responses/ApiPublicationBadRequest"},"401":{"$ref":"#/components/responses/ApiUnauthorized"},"403":{"$ref":"#/components/responses/ApiForbidden"},"404":{"$ref":"#/components/responses/ApiNotFound"}},"tags":["API Publication"]},"get":{"operationId":"fetch-publication","summary":"Get a Publication","description":"Retrieve an API's publication in a portal.\nIf the API is not published to the portal, a 404 response is returned.\n","responses":{"200":{"$ref":"#/components/responses/ApiPublicationResponse"},"401":{"$ref":"#/components/responses/ApiUnauthorized"},"403":{"$ref":"#/components/responses/ApiForbidden"},"404":{"$ref":"#/components/responses/ApiNotFound"}},"tags":["API Publication"]},"delete":{"operationId":"delete-publication","summary":"Delete Publication","description":"Unpublish an API from a portal.","responses":{"204":{"description":"API was successfully unpublished from portal."},"401":{"$ref":"#/components/responses/ApiUnauthorized"},"403":{"$ref":"#/components/responses/ApiForbidden"},"404":{"$ref":"#/components/responses/ApiNotFound"}},"tags":["API Publication"]}},"/api-publications":{"get":{"operationId":"list-api-publications","summary":"List Publications","description":"Returns a collection of all API Publications.","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"},{"$ref":"#/components/parameters/ApiPublicationFilters"},{"$ref":"#/components/parameters/ApiPublicationSort"}],"responses":{"200":{"$ref":"#/components/responses/ListApiPublicationResponse"},"400":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}}},"401":{"$ref":"#/components/responses/ApiUnauthorized"},"403":{"$ref":"#/components/responses/ApiForbidden"},"404":{"$ref":"#/components/responses/ApiNotFound"}},"tags":["API Publication"]}},"/portals/{portalId}/api-publications":{"parameters":[{"$ref":"#/components/parameters/PortalId"}],"get":{"operationId":"list-portal-api-publications","summary":"List Portal API Publications","description":"Returns a collection of all API Publications for a specific portal.\n\n**Access Control**: Requires permission to view the specified portal. Once portal access is granted, all API publications for that portal are returned regardless of the caller's individual API permissions.\n","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"},{"$ref":"#/components/parameters/PortalApiPublicationFilters"},{"$ref":"#/components/parameters/PortalApiPublicationSort"}],"responses":{"200":{"$ref":"#/components/responses/ListPublicationResponse"},"400":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}}},"401":{"$ref":"#/components/responses/ApiUnauthorized"},"403":{"$ref":"#/components/responses/ApiForbidden"},"404":{"$ref":"#/components/responses/ApiNotFound"}},"tags":["API Publication"]}},"/api-packages/{apiPackageId}/publications/{portalId}":{"parameters":[{"$ref":"#/components/parameters/ApiPackageId"},{"$ref":"#/components/parameters/PortalId"}],"put":{"operationId":"publish-api-package-to-portal","summary":"Publish API Package","description":"Publish an API Package to a portal.\n","requestBody":{"$ref":"#/components/requestBodies/PutApiPackagePublicationRequest"},"responses":{"200":{"$ref":"#/components/responses/ApiPackagePublicationResponse"},"400":{"$ref":"#/components/responses/ApiPublicationBadRequest"},"401":{"$ref":"#/components/responses/ApiUnauthorized"},"403":{"$ref":"#/components/responses/ApiForbidden"},"404":{"$ref":"#/components/responses/ApiNotFound"}},"tags":["API Publication"]},"get":{"operationId":"fetch-api-package-publication","summary":"Get an API Package Publication","description":"Retrieve an API Package's publication in a portal.\nIf the API Package is not published to the portal, a 404 response is returned.\n","responses":{"200":{"$ref":"#/components/responses/ApiPackagePublicationResponse"},"401":{"$ref":"#/components/responses/ApiUnauthorized"},"403":{"$ref":"#/components/responses/ApiForbidden"},"404":{"$ref":"#/components/responses/ApiNotFound"}},"tags":["API Publication"]},"delete":{"operationId":"delete-api-package-publication","summary":"Delete API Package Publication","description":"Unpublish an API Package from a portal.","responses":{"204":{"description":"API Package was successfully unpublished from portal."},"401":{"$ref":"#/components/responses/ApiUnauthorized"},"403":{"$ref":"#/components/responses/ApiForbidden"},"404":{"$ref":"#/components/responses/ApiNotFound"}},"tags":["API Publication"]}},"/apis/{apiId}/implementations":{"parameters":[{"$ref":"#/components/parameters/ApiId"}],"post":{"operationId":"create-api-implementation","summary":"Create API Implementation","description":"Creates an implementation for an API.\nIf all operations in an API are implemented by a single gateway service and the service\nhas no routes that are not part of the API, then the API can be linked to the service.\nFor cases where an API is implemented by multiple gateway services, only a subset of\nroutes in one or more gateway services, or API operations need to be made available for API packages,\nthen the API should be linked to the control plane that defines the routes that overlap with the API.\n","requestBody":{"$ref":"#/components/requestBodies/CreateApiImplementationRequest"},"responses":{"201":{"$ref":"#/components/responses/ApiImplementationResponse"},"400":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"},"examples":{"ApiImplementationBadRequestExample":{"$ref":"#/components/examples/ApiImplementationBadRequestExample"}}}}},"401":{"$ref":"#/components/responses/ApiUnauthorized"},"403":{"$ref":"#/components/responses/ApiForbidden"},"404":{"$ref":"#/components/responses/ApiNotFound"},"409":{"$ref":"#/components/responses/ApiImplementationConflict"}},"tags":["API Implementation"]}},"/apis/{apiId}/implementations/{implementationId}":{"parameters":[{"$ref":"#/components/parameters/ApiId"},{"$ref":"#/components/parameters/ImplementationId"}],"get":{"operationId":"fetch-api-implementation","summary":"Get an API Implementation","description":"Retrieve a gateway implementation for this API","responses":{"200":{"$ref":"#/components/responses/ApiImplementationResponse"},"401":{"$ref":"#/components/responses/ApiUnauthorized"},"403":{"$ref":"#/components/responses/ApiForbidden"},"404":{"$ref":"#/components/responses/ApiNotFound"}},"tags":["API Implementation"]},"delete":{"operationId":"delete-api-implementation","summary":"Delete API Implementation","description":"Unlink a gateway implementation from this API","responses":{"204":{"description":"API implementation was unlinked successfully."},"401":{"$ref":"#/components/responses/ApiUnauthorized"},"403":{"$ref":"#/components/responses/ApiForbidden"},"404":{"$ref":"#/components/responses/ApiNotFound"}},"tags":["API Implementation"]}},"/apis/{apiId}/operations":{"parameters":[{"$ref":"#/components/parameters/ApiId"}],"get":{"operationId":"list-api-operations","summary":"List API Operations","description":"Returns a list of operations for an API.\nReturns 404 if the API is not configured for access control enforcement.\n","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"},{"$ref":"#/components/parameters/ApiOperationFilters"}],"responses":{"200":{"$ref":"#/components/responses/ListApiOperationResponse"},"401":{"$ref":"#/components/responses/ApiUnauthorized"},"403":{"$ref":"#/components/responses/ApiForbidden"},"404":{"$ref":"#/components/responses/ApiNotFound"}},"tags":["API Operations"]}},"/apis/{apiId}/operations/{operationId}":{"parameters":[{"$ref":"#/components/parameters/ApiId"},{"$ref":"#/components/parameters/OperationId"}],"get":{"operationId":"fetch-api-operation","summary":"Get an API Operation","description":"Returns a specific operation for an API.\nReturns 404 if the API is not configured for access control enforcement.\n","responses":{"200":{"$ref":"#/components/responses/ApiOperationResponse"},"401":{"$ref":"#/components/responses/ApiUnauthorized"},"403":{"$ref":"#/components/responses/ApiForbidden"},"404":{"$ref":"#/components/responses/ApiNotFound"}},"tags":["API Operations"]}},"/api-implementations":{"get":{"operationId":"list-api-implementations","summary":"List API Implementations","description":"List gateway implementations for this API","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"},{"$ref":"#/components/parameters/ApiImplementationFilters"},{"$ref":"#/components/parameters/ApiImplementationSort"}],"responses":{"200":{"$ref":"#/components/responses/ListApiImplementationsResponse"},"401":{"$ref":"#/components/responses/ApiUnauthorized"},"403":{"$ref":"#/components/responses/ApiForbidden"},"404":{"$ref":"#/components/responses/ApiNotFound"}},"tags":["API Implementation"]}},"/api-attributes":{"get":{"operationId":"list-api-attributes","summary":"List API Attributes","description":"List attributes across all apis","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"},{"$ref":"#/components/parameters/ApiAttributeFilters"},{"$ref":"#/components/parameters/ApiAttributeSort"}],"responses":{"200":{"$ref":"#/components/responses/ListApiAttributesResponse"},"401":{"$ref":"#/components/responses/ApiUnauthorized"},"403":{"$ref":"#/components/responses/ApiForbidden"},"404":{"$ref":"#/components/responses/ApiNotFound"}},"tags":["API Attributes"]}},"/api-packages":{"get":{"operationId":"list-api-packages","summary":"List API Packages","description":"List API packages","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"},{"$ref":"#/components/parameters/ApiPackageFilters"},{"$ref":"#/components/parameters/ApiPackageSort"}],"responses":{"200":{"$ref":"#/components/responses/ListApiPackagesResponse"},"401":{"$ref":"#/components/responses/ApiUnauthorized"},"403":{"$ref":"#/components/responses/ApiForbidden"},"404":{"$ref":"#/components/responses/ApiNotFound"}},"tags":["API Packages"]},"post":{"operationId":"create-api-package","summary":"Create API Package","description":"Creates a package of APIs.\nAn API package is a collection of APIs that can be used to group related APIs together.\n","requestBody":{"$ref":"#/components/requestBodies/CreateApiPackageRequest"},"responses":{"201":{"$ref":"#/components/responses/ApiPackageResponse"},"400":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}}},"401":{"$ref":"#/components/responses/ApiUnauthorized"},"403":{"$ref":"#/components/responses/ApiForbidden"},"404":{"$ref":"#/components/responses/ApiNotFound"}},"tags":["API Packages"]}},"/api-packages/{packageId}":{"parameters":[{"name":"packageId","in":"path","description":"The UUID API Package identifier","required":true,"schema":{"type":"string","format":"uuid","example":"9f5061ce-78f6-4452-9108-ad7c02821fd5"}}],"get":{"operationId":"get-api-package","summary":"Get API Package","description":"Get details of a specific API package.","responses":{"200":{"$ref":"#/components/responses/ApiPackageResponse"},"401":{"$ref":"#/components/responses/ApiUnauthorized"},"403":{"$ref":"#/components/responses/ApiForbidden"},"404":{"$ref":"#/components/responses/ApiNotFound"}},"tags":["API Packages"]},"patch":{"operationId":"patch-api-package","summary":"Patch API Package","description":"Updates an existing API package.\nYou can modify the name, description and version of the API Package.\n","requestBody":{"$ref":"#/components/requestBodies/UpdateApiPackageRequest"},"responses":{"200":{"$ref":"#/components/responses/ApiPackageResponse"},"400":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}}},"401":{"$ref":"#/components/responses/ApiUnauthorized"},"403":{"$ref":"#/components/responses/ApiForbidden"}},"tags":["API Packages"]},"delete":{"operationId":"delete-api-package","summary":"Delete API Package","description":"Deletes an API package.","responses":{"204":{"description":"API package was deleted successfully."},"401":{"$ref":"#/components/responses/ApiUnauthorized"},"403":{"$ref":"#/components/responses/ApiForbidden"},"404":{"$ref":"#/components/responses/ApiNotFound"}},"tags":["API Packages"]}},"/api-packages/{packageId}/documents":{"parameters":[{"name":"packageId","in":"path","description":"The UUID API Package identifier","required":true,"schema":{"type":"string","format":"uuid","example":"9f5061ce-78f6-4452-9108-ad7c02821fd5"}}],"post":{"operationId":"create-api-package-document","summary":"Create API Package Document","description":"Publish a new document attached to an API Package.\n\nAll configuration options may be provided in the frontmatter section of `content`. If you set values in both the `POST` request _and_ in the frontmatter, the values in the `POST` request will take precedence.\n","requestBody":{"$ref":"#/components/requestBodies/CreateApiDocumentRequest"},"responses":{"201":{"$ref":"#/components/responses/ApiPackageDocumentResponse"},"400":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"},"examples":{"ApiNameBadRequestExample":{"$ref":"#/components/examples/ApiDocumentBadRequestExample"}}}}},"401":{"$ref":"#/components/responses/ApiUnauthorized"},"403":{"$ref":"#/components/responses/ApiForbidden"},"404":{"$ref":"#/components/responses/ApiNotFound"},"409":{"$ref":"#/components/responses/ApiSlugConflict"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"}},"tags":["API Package Documentation"]},"get":{"operationId":"list-api-package-documents","summary":"List API Package Documents","description":"Returns a collection of all documents for an API package.","parameters":[{"$ref":"#/components/parameters/ApiDocumentFilters"}],"responses":{"200":{"$ref":"#/components/responses/ListApiPackageDocumentResponse"},"400":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"},"examples":{"InvalidApiSortQueryBadRequestExample":{"$ref":"#/components/examples/InvalidApiSortQueryBadRequestExample"}}}}},"401":{"$ref":"#/components/responses/ApiUnauthorized"},"403":{"$ref":"#/components/responses/ApiForbidden"},"404":{"$ref":"#/components/responses/ApiNotFound"}},"tags":["API Package Documentation"]}},"/api-packages/{packageId}/documents/{documentId}":{"parameters":[{"name":"packageId","in":"path","description":"The UUID API Package identifier","required":true,"schema":{"type":"string","format":"uuid","example":"9f5061ce-78f6-4452-9108-ad7c02821fd5"}},{"$ref":"#/components/parameters/DocumentId"}],"get":{"operationId":"fetch-api-package-document","summary":"Get an API Package Document","description":"Returns a document for the API Package.","responses":{"200":{"$ref":"#/components/responses/ApiPackageDocumentResponse"},"401":{"$ref":"#/components/responses/ApiUnauthorized"},"403":{"$ref":"#/components/responses/ApiForbidden"},"404":{"$ref":"#/components/responses/ApiNotFound"}},"tags":["API Package Documentation"]},"patch":{"operationId":"update-api-package-document","summary":"Update API Package Document","description":"Updates a document for an API Package.","requestBody":{"$ref":"#/components/requestBodies/UpdateApiDocumentRequest"},"responses":{"200":{"$ref":"#/components/responses/ApiPackageDocumentResponse"},"400":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"},"examples":{"ApiNameBadRequestExample":{"$ref":"#/components/examples/ApiDocumentBadRequestExample"}}}}},"401":{"$ref":"#/components/responses/ApiUnauthorized"},"403":{"$ref":"#/components/responses/ApiForbidden"},"404":{"$ref":"#/components/responses/ApiNotFound"},"409":{"$ref":"#/components/responses/ApiSlugConflict"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"}},"tags":["API Package Documentation"]},"delete":{"operationId":"delete-api-package-document","summary":"Delete API Package Documentation","description":"Removes a document from an API Package.","responses":{"204":{"description":"Document for the API was deleted successfully."},"401":{"$ref":"#/components/responses/ApiUnauthorized"},"403":{"$ref":"#/components/responses/ApiForbidden"},"404":{"$ref":"#/components/responses/ApiNotFound"}},"tags":["API Package Documentation"]}},"/api-packages/{packageId}/documents/{documentId}/move":{"parameters":[{"name":"packageId","in":"path","description":"The UUID API Package identifier","required":true,"schema":{"type":"string","format":"uuid","example":"9f5061ce-78f6-4452-9108-ad7c02821fd5"}},{"$ref":"#/components/parameters/DocumentId"}],"post":{"operationId":"move-api-package-document","summary":"Move API Package Documentation","description":"This api allows the user to move a document within the document tree using the parameters parent_document_id and index. If parent_document_id is not provided, the document will be placed at the top level of the document tree. index represents a zero-indexed document order relative to its siblings under the same parent. For example, if we want to put the document at top level in first position we would send parent_document_id: null and index: 0. This api also supports using a negative index to count backwards from the end of the document list, which means you can put the document in last position by using index: -1.","requestBody":{"$ref":"#/components/requestBodies/MoveDocumentRequest"},"responses":{"204":{"description":"Document for the API Package was moved successfully."},"401":{"$ref":"#/components/responses/ApiUnauthorized"},"403":{"$ref":"#/components/responses/ApiForbidden"},"404":{"$ref":"#/components/responses/ApiNotFound"},"409":{"$ref":"#/components/responses/Conflict"}},"tags":["API Package Documentation"]}},"/api-packages/{packageId}/operations":{"parameters":[{"name":"packageId","in":"path","description":"The UUID API Package identifier","required":true,"schema":{"type":"string","format":"uuid","example":"9f5061ce-78f6-4452-9108-ad7c02821fd5"}}],"get":{"operationId":"list-api-packages-operations","summary":"List API Packages Operations","description":"List API packages operations","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"},{"$ref":"#/components/parameters/ApiPackageOperationsFilters"},{"$ref":"#/components/parameters/ApiPackageOperationsSort"}],"responses":{"200":{"$ref":"#/components/responses/ListApiPackagesOperationsResponse"},"401":{"$ref":"#/components/responses/ApiUnauthorized"},"403":{"$ref":"#/components/responses/ApiForbidden"},"404":{"$ref":"#/components/responses/ApiNotFound"}},"tags":["API Package Operations"]},"patch":{"operationId":"update-api-package-operations","summary":"Update API Package Operation","description":"Update API Package Operations","requestBody":{"$ref":"#/components/requestBodies/UpdateApiPackageOperationRequest"},"responses":{"204":{"description":"API operations were successfully added or removed to the package."},"400":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}}},"401":{"$ref":"#/components/responses/ApiUnauthorized"},"403":{"$ref":"#/components/responses/ApiForbidden"},"404":{"$ref":"#/components/responses/ApiNotFound"},"409":{"$ref":"#/components/responses/ApiSlugConflict"}},"tags":["API Package Operations"]}},"/api-packages/{packageId}/operations/{operationId}":{"parameters":[{"name":"packageId","in":"path","description":"The UUID API Package identifier","required":true,"schema":{"type":"string","format":"uuid","example":"9f5061ce-78f6-4452-9108-ad7c02821fd5"}},{"name":"operationId","in":"path","description":"The UUID API Operation identifier","required":true,"schema":{"type":"string","format":"uuid","example":"9f5061ce-78f6-4452-9108-ad7c02821fd5"}}],"get":{"operationId":"get-api-packages-operation","summary":"Get API Packages Operation","description":"Get API packages operation","responses":{"200":{"$ref":"#/components/responses/ApiPackageOperationResponse"},"401":{"$ref":"#/components/responses/ApiUnauthorized"},"403":{"$ref":"#/components/responses/ApiForbidden"},"404":{"$ref":"#/components/responses/ApiNotFound"}},"tags":["API Package Operations"]},"delete":{"operationId":"remove-api-package-operation","summary":"Remove API Package Operation","description":"Remove an operation from an API package.","responses":{"204":{"description":"API operation was removed successfully from the package."},"401":{"$ref":"#/components/responses/ApiUnauthorized"},"403":{"$ref":"#/components/responses/ApiForbidden"},"404":{"$ref":"#/components/responses/ApiNotFound"}},"tags":["API Package Operations"]}},"/api-packages/{packageId}/current-specification":{"parameters":[{"name":"packageId","in":"path","description":"The UUID API Package identifier","required":true,"schema":{"type":"string","format":"uuid","example":"9f5061ce-78f6-4452-9108-ad7c02821fd5"}}],"put":{"operationId":"update-api-package-current-specification","summary":"Update API package current specification","description":"Updates the current specification of an API package.\n","requestBody":{"$ref":"#/components/requestBodies/UpdateApiSpecRequest"},"responses":{"200":{"$ref":"#/components/responses/ApiSpecResponse"},"400":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"},"examples":{"ApiNameBadRequestExample":{"$ref":"#/components/examples/ApiDocumentBadRequestExample"}}}}},"401":{"$ref":"#/components/responses/ApiUnauthorized"},"403":{"$ref":"#/components/responses/ApiForbidden"},"404":{"$ref":"#/components/responses/ApiNotFound"},"409":{"$ref":"#/components/responses/ApiSlugConflict"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"}},"tags":["API Package Specification"]},"get":{"operationId":"get-api-package-current-specification","summary":"Get the API package current specification","description":"Fetches the current specification of an API Package.","responses":{"200":{"$ref":"#/components/responses/ApiSpecResponse"},"400":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"},"examples":{"InvalidApiSortQueryBadRequestExample":{"$ref":"#/components/examples/InvalidApiSortQueryBadRequestExample"}}}}},"401":{"$ref":"#/components/responses/ApiUnauthorized"},"403":{"$ref":"#/components/responses/ApiForbidden"},"404":{"$ref":"#/components/responses/ApiNotFound"}},"tags":["API Package Specification"]},"delete":{"operationId":"delete-api-package-current-specification","summary":"Delete API Package current Specification","description":"Deletes the current specification of an API Package.\n","responses":{"204":{"description":"API Package Specification was deleted successfully."},"401":{"$ref":"#/components/responses/ApiUnauthorized"},"403":{"$ref":"#/components/responses/ApiForbidden"},"404":{"$ref":"#/components/responses/ApiNotFound"}},"tags":["API Package Specification"]}},"/api-packages/{packageId}/computed-specification":{"parameters":[{"name":"packageId","in":"path","description":"The UUID API Package identifier","required":true,"schema":{"type":"string","format":"uuid","example":"9f5061ce-78f6-4452-9108-ad7c02821fd5"}}],"get":{"operationId":"get-api-package-computed-specification","summary":"Get the API package computed specification","description":"Fetches the computed specification of an API Package.","responses":{"200":{"$ref":"#/components/responses/ApiSpecResponse"},"400":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}}},"401":{"$ref":"#/components/responses/ApiUnauthorized"},"403":{"$ref":"#/components/responses/ApiForbidden"},"404":{"$ref":"#/components/responses/ApiNotFound"}},"tags":["API Package Specification"]}}},"components":{"parameters":{"ApiAttributeFilters":{"name":"filter","description":"Filters API attributes in the response.","required":false,"in":"query","schema":{"$ref":"#/components/schemas/ApiAttributeFilterParameters"},"style":"deepObject"},"ApiAttributeSort":{"name":"sort","description":"Sorts a collection of API attributes. Supported sort attributes are:\n  - id\n  - key\n  - created_at\n  - updated_at\n","required":false,"in":"query","schema":{"$ref":"#/components/schemas/SortQuery"}},"ApiDocumentFilters":{"name":"filter","description":"Filters API Documents in the response.","required":false,"in":"query","schema":{"$ref":"#/components/schemas/ApiDocumentFilterParameters"},"style":"deepObject"},"ApiFilters":{"name":"filter","description":"Filters APIs in the response.","required":false,"in":"query","schema":{"$ref":"#/components/schemas/ApiFilterParameters"},"style":"deepObject"},"ApiId":{"schema":{"type":"string","format":"uuid","example":"9f5061ce-78f6-4452-9108-ad7c02821fd5"},"name":"apiId","in":"path","required":true,"description":"The UUID API identifier"},"ApiImplementationFilters":{"name":"filter","description":"Filters APIs in the response.","required":false,"in":"query","schema":{"$ref":"#/components/schemas/ApiImplementationFilterParameters"},"style":"deepObject"},"ApiImplementationSort":{"name":"sort","description":"Sorts a collection of API implementations. Supported sort attributes are:\n  - id\n  - api_id\n  - control_plane_id\n  - service_id\n  - created_at\n  - updated_at\n","required":false,"in":"query","schema":{"$ref":"#/components/schemas/SortQuery"}},"ApiOperationFilters":{"name":"filter","description":"Filters API Operations in the response.","required":false,"in":"query","schema":{"$ref":"#/components/schemas/ApiOperationFilterParameters"},"style":"deepObject"},"ApiPackageFilters":{"name":"filter","description":"Filters API Packages in the response.","required":false,"in":"query","schema":{"$ref":"#/components/schemas/ApiPackageFilterParameters"},"style":"deepObject"},"ApiPackageId":{"schema":{"type":"string","format":"uuid","example":"9f5061ce-78f6-4452-9108-ad7c02821fd5"},"name":"apiPackageId","in":"path","required":true,"description":"The UUID API Package identifier"},"ApiPackageOperationsFilters":{"name":"filter","description":"Filters API Packages operations in the response.","required":false,"in":"query","schema":{"$ref":"#/components/schemas/ApiPackageOperationsFilterParameters"},"style":"deepObject"},"ApiPackageOperationsSort":{"name":"sort","description":"Sorts a collection of API Packages Operations. Supported sort attributes are:\n  - path\n  - method\n  - api_id\n  - created_at\n  - updated_at\n","required":false,"in":"query","schema":{"$ref":"#/components/schemas/SortQuery"}},"ApiPackageSort":{"name":"sort","description":"Sorts a collection of API Packages. Supported sort attributes are:\n  - name\n  - version\n  - created_at\n  - updated_at\n","required":false,"in":"query","schema":{"$ref":"#/components/schemas/SortQuery"}},"ApiPublicationFilters":{"name":"filter","description":"Filters API Publications in the response.","required":false,"in":"query","schema":{"$ref":"#/components/schemas/ApiPublicationFilterParameters"},"style":"deepObject"},"ApiPublicationSort":{"name":"sort","description":"Sorts a collection of API publications. Supported sort attributes are:\n  - portal_id\n  - portal_name\n  - api_id\n  - api_name\n  - created_at\n  - updated_at\n","required":false,"in":"query","schema":{"$ref":"#/components/schemas/SortQuery"}},"ApiSort":{"name":"sort","description":"Sorts a collection of APIs. Supported sort attributes are:\n  - name\n  - version\n  - created_at\n  - updated_at\n","required":false,"in":"query","schema":{"$ref":"#/components/schemas/SortQuery"}},"ApiSpecFilters":{"name":"filter","description":"Filters API Specs in the response.","required":false,"in":"query","schema":{"$ref":"#/components/schemas/ApiSpecFilterParameters"},"style":"deepObject"},"ApiVersionFilters":{"name":"filter","description":"Filters API Version in the response.","required":false,"in":"query","schema":{"$ref":"#/components/schemas/ApiVersionFilterParameters"},"style":"deepObject"},"ApiVersionSort":{"name":"sort","description":"Sorts a collection of API versions. Supported sort attributes are:\n  - created_at\n","required":false,"in":"query","schema":{"$ref":"#/components/schemas/SortQuery"}},"DocumentId":{"schema":{"type":"string","format":"uuid","example":"de5c9818-be5c-42e6-b514-e3d4bc30ddeb"},"name":"documentId","description":"The document identifier related to the API","in":"path","required":true},"ImplementationId":{"schema":{"type":"string","format":"uuid","example":"032d905a-ed33-46a3-a093-d8f536af9a8a"},"name":"implementationId","in":"path","required":true,"description":"The Portal identifier"},"OperationId":{"schema":{"type":"string","format":"uuid","example":"b42d905a-ed33-46a3-a093-d8f536af9a8a"},"name":"operationId","in":"path","required":true,"description":"The API operation identifier"},"PageNumber":{"name":"page[number]","description":"Determines which page of the entities to retrieve.","required":false,"in":"query","allowEmptyValue":true,"schema":{"type":"integer","example":1}},"PageSize":{"name":"page[size]","description":"The maximum number of items to include per page. The last page of a collection may include fewer items.","required":false,"in":"query","allowEmptyValue":true,"schema":{"type":"integer","example":10}},"PortalApiPublicationFilters":{"name":"filter","description":"Filters API Publications in a portal response (excludes portal-specific filters).","required":false,"in":"query","schema":{"$ref":"#/components/schemas/PortalApiPublicationFilterParameters"},"style":"deepObject"},"PortalApiPublicationSort":{"name":"sort","description":"Sorts a collection of API publications within a portal. Supported sort attributes are:\n  - api_id\n  - api_name\n  - created_at\n  - updated_at\n","required":false,"in":"query","schema":{"$ref":"#/components/schemas/SortQuery"}},"PortalId":{"schema":{"type":"string","format":"uuid","example":"f32d905a-ed33-46a3-a093-d8f536af9a8a"},"name":"portalId","in":"path","required":true,"description":"The Portal identifier"},"SpecId":{"schema":{"type":"string","format":"uuid","example":"d32d905a-ed33-46a3-a093-d8f536af9a8a"},"name":"specId","description":"The API specification identifier","in":"path","required":true},"VersionId":{"schema":{"type":"string","format":"uuid","example":"d32d905a-ed33-46a3-a093-d8f536af9a8a"},"name":"versionId","description":"The API version identifier","in":"path","required":true}},"schemas":{"ApiResponseSchema":{"type":"object","properties":{"id":{"description":"The API identifier.","type":"string","format":"uuid","example":"9f5061ce-78f6-4452-9108-ad7c02821fd5","readOnly":true},"name":{"description":"The name of your API. The `name + version` combination must be unique for each API you publish.\n","type":"string","example":"MyAPI","maxLength":255,"minLength":1},"description":{"description":"A description of your API. Will be visible on your live Portal.","type":"string","nullable":true},"version":{"description":"An optional version for your API. Leave this empty if your API is unversioned.","type":"string","maxLength":255,"minLength":1,"nullable":true},"current_version_summary":{"$ref":"#/components/schemas/ApiVersionSummary"},"slug":{"description":"The `slug` is used in generated URLs to provide human readable paths.\n\nDefaults to `slugify(name + version)`\n","type":"string","example":"my-api-v1","nullable":true,"pattern":"^[\\w-]+$"},"api_spec_ids":{"description":"The list of API specification ids for the API.","type":"array","items":{"type":"string","format":"uuid","description":"The id of the API specification.","example":"123e4567-e89b-12d3-a456-426614174000"},"deprecated":true,"readOnly":true},"portals":{"description":"The list of portals which this API is published to.","type":"array","items":{"type":"object","additionalProperties":false,"required":["id","name","display_name"],"properties":{"id":{"description":"The portal identifier.","type":"string","format":"uuid","example":"25a2624c-49fc-4764-99e1-224ed819f200"},"name":{"description":"The name of the portal, used to distinguish it from other portals.","type":"string","example":"My Portal"},"display_name":{"description":"The display name of the portal. This value will be the portal's `name` in Portal API.","type":"string","example":"My Portal"}}},"nullable":false,"readOnly":true,"uniqueItems":true},"labels":{"$ref":"#/components/schemas/Labels"},"implementation_mode":{"description":"the implementations that are associated with this api either gateway_entity_binding or access_control_enforcement","type":"string","nullable":true,"readOnly":true},"attributes":{"$ref":"#/components/schemas/ApiAttributes"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"additionalProperties":false,"required":["id","name","version","labels","created_at","updated_at","slug","portals","api_spec_ids","current_version_summary"],"title":"API"},"AuthStrategyApiSyncError":{"type":"object","properties":{"control_plane_error":{"type":"string","enum":["control_plane_error_no_response","control_plane_error_invalid_response","control_plane_error_unavailable","control_plane_error_internal_error","control_plane_error_bad_request","control_plane_error_plugin_conflict","control_plane_error_data_constraint_error","control_plane_error_implementation_not_found"]},"message":{"type":"string"},"info":{"type":"object","additionalProperties":true,"properties":{"details":{"type":"array","items":{"type":"object","additionalProperties":true,"properties":{"type":{"type":"string"},"message":{"type":"array","items":{"type":"string"}}}}}}}},"example":{"control_plane_error":"control_plane_error_unavailable","message":"Unable to connect to the control plane to update plugin"},"additionalProperties":false,"nullable":true,"required":["message"]},"ApiDocumentId":{"description":"The API document identifier.","type":"string","format":"uuid","example":"de5c9818-be5c-42e6-b514-e3d4bc30ddeb","readOnly":true,"title":"API Document ID"},"ApiDocumentContent":{"description":"Raw markdown content to display in your Portal","type":"string","title":"API Document Content"},"ApiDocumentTitle":{"description":"The title of the document. Used to populate the `<title>` tag for the page","type":"string","example":"API Document","title":"API Document Title"},"ApiDocumentStatus":{"description":"If `status=published` the document will be visible in your live portal","type":"string","default":"unpublished","enum":["published","unpublished"]},"ApiDocumentParentDocumentId":{"description":"API Documents may be rendered as a tree of files.\n\nSpecify the `id` of another API Document as the `parent_document_id` to add some heirarchy do your documents.\n","type":"string","format":"uuid","example":null,"nullable":true,"title":"API Document Parent Document ID"},"ApiDocumentSlug":{"description":"The `slug` is used in generated URLs to provide human readable paths.\n\nDefaults to `slugify(title)`\n","type":"string","example":"api-document","pattern":"^[\\w-]+$","title":"API Document Slug"},"ApiDocumentSummaryWithChildren":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ApiDocumentId"},"title":{"$ref":"#/components/schemas/ApiDocumentTitle"},"slug":{"$ref":"#/components/schemas/ApiDocumentSlug"},"status":{"$ref":"#/components/schemas/ApiDocumentStatus"},"parent_document_id":{"$ref":"#/components/schemas/ApiDocumentParentDocumentId"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"},"children":{"type":"array","items":{"$ref":"#/components/schemas/ApiDocumentSummaryWithChildren"}}},"additionalProperties":false,"required":["id","title","slug","status","parent_document_id","created_at","updated_at","children"],"title":"API Document Summary"},"ApiDocument":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ApiDocumentId"},"content":{"$ref":"#/components/schemas/ApiDocumentContent"},"title":{"$ref":"#/components/schemas/ApiDocumentTitle"},"slug":{"$ref":"#/components/schemas/ApiDocumentSlug"},"status":{"$ref":"#/components/schemas/ApiDocumentStatus"},"parent_document_id":{"$ref":"#/components/schemas/ApiDocumentParentDocumentId"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"additionalProperties":false,"title":"API Document"},"MoveDocumentRequestPayload":{"description":"move document request payload","type":"object","properties":{"parent_document_id":{"description":"parent document id","type":"string","format":"uuid","example":"dd4e1b98-3629-4dd3-acc0-759a726ffee2"},"index":{"description":"index of the document in the parent document's children","type":"integer","example":1}},"title":"Move document"},"ApiVersion":{"type":"object","properties":{"id":{"description":"The API version identifier.","type":"string","format":"uuid","example":"7710d5c4-d902-410b-992f-18b814155b53","readOnly":true},"version":{"description":"The version of the api.","type":"string","example":"1.0.0"},"spec":{"type":"object","additionalProperties":false,"properties":{"content":{"description":"The raw content of your API spec, in json or yaml format (OpenAPI or AsyncAPI).\n","example":"{\"openapi\":\"3.0.3\",\"info\":{\"title\":\"Example API\",\"version\":\"1.0.0\"},\"paths\":{\"/example\":{\"get\":{\"summary\":\"Example endpoint\",\"responses\":{\"200\":{\"description\":\"Successful response\"}}}}}}","type":"string"},"type":{"description":"The type of specification being stored. This allows us to render the specification correctly.\n","type":"string","example":"oas3","enum":["oas2","oas3","asyncapi"],"readOnly":true,"title":"API Spec Type"},"validation_messages":{"description":"The errors that occurred while parsing the API version spec.","type":"array","items":{"type":"object","additionalProperties":false,"required":["message"],"properties":{"message":{"type":"string"}}},"readOnly":true}}},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"additionalProperties":false,"title":"API Version"},"ApiVersionSummary":{"type":"object","properties":{"id":{"description":"The API version identifier.","type":"string","format":"uuid","example":"7710d5c4-d902-410b-992f-18b814155b53","readOnly":true},"version":{"description":"The version of this api spec.","type":"string"},"spec":{"type":"object","additionalProperties":false,"properties":{"type":{"$ref":"#/components/schemas/ApiSpecType"}}},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"additionalProperties":false,"nullable":true,"readOnly":true,"title":"API Version Summary"},"ApiSpec":{"type":"object","properties":{"id":{"description":"The API specification identifier.","type":"string","format":"uuid","example":"7710d5c4-d902-410b-992f-18b814155b53","readOnly":true},"content":{"description":"The raw content of your API specification, in json or yaml format (OpenAPI or AsyncAPI).\n","example":"{\"openapi\":\"3.0.3\",\"info\":{\"title\":\"Example API\",\"version\":\"1.0.0\"},\"paths\":{\"/example\":{\"get\":{\"summary\":\"Example endpoint\",\"responses\":{\"200\":{\"description\":\"Successful response\"}}}}}}","type":"string"},"validation_messages":{"description":"The errors that occurred while parsing the API specification.","type":"array","items":{"type":"object","additionalProperties":false,"required":["message"],"properties":{"message":{"type":"string"}}},"readOnly":true},"type":{"description":"The type of specification being stored. This allows us to render the specification correctly.\n","type":"string","example":"oas3","enum":["oas2","oas3","asyncapi"],"title":"API Spec Type"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"additionalProperties":false,"title":"API Specification"},"ValidateApiSpecRequestPayload":{"type":"object","properties":{"content":{"description":"The raw content of your API specification (OpenAPI or AsyncAPI), in json or yaml, to be validated.\n","type":"string"}},"additionalProperties":false,"required":["content"],"title":"API Specification Validation Request Payload"},"ValidateApiSpecSuccessResponse":{"type":"object","properties":{"validation_messages":{"description":"Any informational messages or warnings generated during validation. Empty if none.","type":"array","items":{"type":"object","additionalProperties":false,"required":["message"],"properties":{"message":{"type":"string"}}}}},"additionalProperties":false,"required":["validation_messages"],"title":"API Specification Validation Success Response"},"ApiPublicationVisibility":{"description":"The visibility of the API in the portal.\nPublic API publications do not require authentication to view and retrieve information about them.\nPrivate API publications require authentication to retrieve information about them.\n","type":"string","default":"private","enum":["public","private"],"title":"API Publication Visibility"},"ApiPublicationAuthStrategyIds":{"description":"The auth strategy the API enforces for applications in the portal.\nOmitting this property means the portal's default application auth strategy will be used.\nSetting to null means the API will not require application authentication.\nDCR support for application registration is currently in development.\n","type":"array","items":{"type":"string","format":"uuid"},"maxItems":1,"minItems":1,"nullable":true,"title":"API Publication Auth Strategy IDs"},"ApiPublicationListItem":{"description":"An API publication in a portal","type":"object","properties":{"api_id":{"description":"The API identifier.","type":"string","format":"uuid","example":"9f5061ce-78f6-4452-9108-ad7c02821fd5","readOnly":true},"portal_id":{"description":"The portal identifier.","type":"string","format":"uuid","example":"7710d5c4-d902-410b-992f-18b814155b53","readOnly":true},"auto_approve_registrations":{"$ref":"#/components/schemas/AutoApproveRegistrations"},"entity_type":{"$ref":"#/components/schemas/EntityType"},"visibility":{"$ref":"#/components/schemas/ApiPublicationVisibility"},"auth_strategy_ids":{"$ref":"#/components/schemas/ApiPublicationAuthStrategyIds"},"warnings":{"description":"Informational warnings (e.g. incompatible fields stripped for ACE). Empty if none.","type":"array","items":{"type":"string"},"readOnly":true},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"additionalProperties":false,"required":["api_id","portal_id","visibility","created_at","updated_at","auth_strategy_ids","auto_approve_registrations","entity_type"],"title":"API Publication List Item"},"PublicationListItem":{"description":"An API or API Package publication in a portal","type":"object","properties":{"api_id":{"description":"The API identifier.","type":"string","format":"uuid","example":"9f5061ce-78f6-4452-9108-ad7c02821fd5","readOnly":true},"portal_ids":{"description":"The portal identifier.","type":"array","items":{"type":"string","format":"uuid"},"example":["7710d5c4-d902-410b-992f-18b814155b53"],"readOnly":true},"auto_approve_registrations":{"$ref":"#/components/schemas/AutoApproveRegistrations"},"entity_type":{"$ref":"#/components/schemas/EntityType"},"visibility":{"$ref":"#/components/schemas/ApiPublicationVisibility"},"auth_strategy_ids":{"$ref":"#/components/schemas/ApiPublicationAuthStrategyIds"},"warnings":{"description":"Informational warnings (e.g. incompatible fields stripped for ACE). Empty if none.","type":"array","items":{"type":"string"},"readOnly":true},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"additionalProperties":false,"required":["api_id","portal_ids","visibility","created_at","updated_at","auth_strategy_ids","auto_approve_registrations","entity_type"],"title":"Publication List Item"},"AutoApproveRegistrations":{"description":"Whether the application registration auto approval on this portal for the api is enabled. If set to false, fallbacks on portal's auto_approve_applications value.","type":"boolean","title":"Auto Approve Registrations"},"ApiPublication":{"description":"An API publication in a portal","type":"object","properties":{"auto_approve_registrations":{"$ref":"#/components/schemas/AutoApproveRegistrations"},"auth_strategy_ids":{"$ref":"#/components/schemas/ApiPublicationAuthStrategyIds"},"visibility":{"$ref":"#/components/schemas/ApiPublicationVisibility"},"warnings":{"description":"Informational warnings (e.g. incompatible fields stripped for ACE). Empty if none.","type":"array","items":{"type":"string"},"readOnly":true},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"additionalProperties":false,"title":"API Publication"},"ApiPackagePublication":{"description":"An API Package publication in a portal","type":"object","properties":{"auto_approve_registrations":{"$ref":"#/components/schemas/AutoApproveRegistrations"},"auth_strategy_ids":{"$ref":"#/components/schemas/ApiPublicationAuthStrategyIds"},"visibility":{"$ref":"#/components/schemas/ApiPublicationVisibility"},"warnings":{"description":"Informational warnings (e.g. incompatible fields stripped for ACE). Empty if none.","type":"array","items":{"type":"string"},"readOnly":true},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"additionalProperties":false,"title":"API Package Publication"},"ApiImplementationService":{"description":"A Gateway service that implements an API","type":"object","properties":{"control_plane_id":{"type":"string","format":"uuid","example":"9f5061ce-78f6-4452-9108-ad7c02821fd5"},"id":{"type":"string","format":"uuid","example":"7710d5c4-d902-410b-992f-18b814155b53"},"auth_strategy_sync_error":{"allOf":[{"$ref":"#/components/schemas/AuthStrategyApiSyncError"}],"readOnly":true}},"additionalProperties":false,"required":["control_plane_id","id"],"title":"API Implementation Service"},"ApiImplementationControlPlane":{"description":"A Control plane that implements an API","type":"object","properties":{"access_control_enforcement_enabled":{"description":"Indicates if the access control enforcement plugin is installed globally in the target control plane","type":"boolean","readOnly":true},"control_plane_id":{"type":"string","format":"uuid","example":"7710d5c4-d902-410b-992f-18b814155b53"}},"additionalProperties":false,"required":["control_plane_id"],"title":"API Implementation Control Plane"},"ApiImplementationListItem":{"description":"An entity that implements an API","type":"object","oneOf":[{"$ref":"#/components/schemas/ApiImplementationListItemGatewayServiceEntity"},{"$ref":"#/components/schemas/ApiImplementationListItemControlPlaneEntity"}],"title":"API Implementation List Item"},"ApiImplementationListItemGatewayServiceEntity":{"description":"An API Implementation list item for gateway services","type":"object","properties":{"id":{"$ref":"#/components/schemas/UUID"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"},"api_id":{"description":"The API identifier.","type":"string","format":"uuid","example":"9f5061ce-78f6-4452-9108-ad7c02821fd5","readOnly":true},"service":{"$ref":"#/components/schemas/ApiImplementationService"}},"additionalProperties":false,"required":["id","api_id","created_at","updated_at"],"title":"ApiImplementationListItemGatewayServiceEntity"},"ApiImplementationListItemControlPlaneEntity":{"description":"An API Implementation list item for control planes","type":"object","properties":{"id":{"$ref":"#/components/schemas/UUID"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"},"api_id":{"description":"The API identifier.","type":"string","format":"uuid","example":"9f5061ce-78f6-4452-9108-ad7c02821fd5","readOnly":true},"control_plane":{"$ref":"#/components/schemas/ApiImplementationControlPlane"}},"additionalProperties":false,"required":["id","api_id","created_at","updated_at","control_plane"],"title":"ApiImplementationListItemControlPlaneEntity"},"ApiImplementation":{"description":"An entity that implements an API","type":"object","oneOf":[{"$ref":"#/components/schemas/ApiImplementationGatewayServiceEntity"},{"$ref":"#/components/schemas/ApiImplementationControlPlaneEntity"}],"title":"API Implementation"},"ApiImplementationGatewayServiceEntity":{"description":"A gateway service that implements an API","type":"object","properties":{"id":{"$ref":"#/components/schemas/UUID"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"},"service":{"$ref":"#/components/schemas/ApiImplementationService"}},"additionalProperties":false,"title":"ApiImplementationGatewayServiceEntity"},"ApiImplementationControlPlaneEntity":{"description":"A control plane that implements an API","type":"object","properties":{"id":{"$ref":"#/components/schemas/UUID"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"},"control_plane":{"$ref":"#/components/schemas/ApiImplementationControlPlane"}},"additionalProperties":false,"title":"ApiImplementationControlPlaneEntity"},"ApiAttributeListItem":{"description":"Entities that describe APIs","type":"object","properties":{"id":{"$ref":"#/components/schemas/UUID"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"},"key":{"description":"A unique key that can contain lowercase letters, numbers, hyphens, and underscores","type":"string","format":"^[a-z0-9-_]{0,128}$","example":"kind","maxLength":128},"values":{"type":"array","items":{"type":"object","required":["value","api_count"],"properties":{"value":{"description":"A keyword describing the API under the attribute key","type":"string","example":"REST","maxLength":512,"minLength":1,"pattern":"^[^,<>]*$"},"api_count":{"type":"integer"}}}}},"additionalProperties":false,"readOnly":true,"required":["id","key","values","created_at","updated_at"],"title":"API Attribute List Item"},"ApiAttributes":{"description":"A set of attributes that describe the API","type":"object","example":{"env":["production"],"domains":["web","mobile"]},"default":{},"additionalProperties":{"nullable":true,"description":"Set of attributes with unique keys. Each key can include lowercase letters, numbers, hyphens, and underscores.","type":"array","minItems":1,"maxItems":20,"items":{"type":"string","minLength":1,"maxLength":512,"pattern":"^[^,<>]*$"}},"nullable":false,"title":"API Attributes"},"ApiOperation":{"description":"An operation linked to an API","type":"object","properties":{"id":{"description":"The API operation identifier.","type":"string","format":"uuid","example":"b42d905a-ed33-46a3-a093-d8f536af9a8a","readOnly":true},"method":{"$ref":"#/components/schemas/Method"},"path":{"description":"The path of the operation.","type":"string","example":"/users/*"},"implementation_status":{"$ref":"#/components/schemas/ApiOperationImplementationStatus"}},"additionalProperties":false,"required":["id","method","path"],"title":"API Operation"},"ApiOperationImplementationStatus":{"description":"The implementation status of the operation.","type":"object","properties":{"matched":{"description":"Whether the operation is matched by a Kong route in the control plane","type":"boolean","readOnly":true},"route":{"type":"object","additionalProperties":false,"nullable":true,"properties":{"id":{"description":"The route identifier","type":"string","format":"uuid"},"name":{"description":"The name of the route","type":"string"}},"readOnly":true,"required":["id","name"]},"service":{"type":"object","additionalProperties":false,"nullable":true,"properties":{"id":{"description":"The service identifier","type":"string","format":"uuid"},"name":{"description":"The name of the service","type":"string"}},"readOnly":true,"required":["id","name"]}},"additionalProperties":false,"required":["matched","route","service"],"title":"API Operation Implementation Status"},"APIPackageJSONPatchOperation":{"description":"A JSON Patch operation to add or remove API Operations from a Package.","type":"array","items":{"$ref":"#/components/schemas/APIPackageJSONPatchItem"},"minItems":1,"title":"JSON Patch Operation"},"APIPackageJSONPatchItem":{"description":"A JSON Patch operation to add or remove an API Operation from a Package.","type":"object","properties":{"op":{"description":"The operation to perform.","type":"string","enum":["add","remove","replace"]},"path":{"description":"The path to the API Operation in the Package, in the format \"operations/<uuid>\".","type":"string","pattern":"^operations/[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"},"value":{"type":"object","additionalProperties":false,"properties":{"rate_limiting_config":{"$ref":"#/components/schemas/RateLimitingConfig"}},"required":["rate_limiting_config"]}},"additionalProperties":false,"required":["op","path"]},"ApiFilterParameters":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/UuidFieldFilter"},"name":{"$ref":"#/components/schemas/StringFieldFilter"},"version":{"$ref":"#/components/schemas/StringFieldFilter"},"labels":{"$ref":"#/components/schemas/LabelsFieldFilter"},"attributes":{"$ref":"#/components/schemas/AttributesFieldFilter"},"implementation_mode":{"$ref":"#/components/schemas/StringFieldFilter"},"created_at":{"$ref":"#/components/schemas/DateTimeFieldFilter"},"updated_at":{"$ref":"#/components/schemas/DateTimeFieldFilter"}},"title":"API Filter Parameters"},"ApiPackageFilterParameters":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/UuidFieldFilter"},"name":{"$ref":"#/components/schemas/StringFieldFilter"},"version":{"$ref":"#/components/schemas/StringFieldFilter"},"labels":{"$ref":"#/components/schemas/LabelsFieldFilter"},"attributes":{"$ref":"#/components/schemas/AttributesFieldFilter"},"created_at":{"$ref":"#/components/schemas/DateTimeFieldFilter"},"updated_at":{"$ref":"#/components/schemas/DateTimeFieldFilter"}},"title":"API Package Filter Parameters"},"ApiPackageOperationsFilterParameters":{"type":"object","properties":{"api_id":{"$ref":"#/components/schemas/UuidFieldFilter"},"method":{"$ref":"#/components/schemas/StringFieldFilter"},"path":{"$ref":"#/components/schemas/StringFieldFilter"},"created_at":{"$ref":"#/components/schemas/DateTimeFieldFilter"},"updated_at":{"$ref":"#/components/schemas/DateTimeFieldFilter"}},"title":"API Package Operations Filter Parameters"},"ApiDocumentFilterParameters":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/StringFieldFilter"}},"title":"API Document Filter Parameters"},"ApiSpecFilterParameters":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/StringFieldFilter"}},"title":"API Spec Filter Parameters"},"ApiVersionFilterParameters":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/StringFieldFilter"},"version":{"$ref":"#/components/schemas/StringFieldFilter"}},"title":"API Spec Filter Parameters"},"ApiPublicationFilterParameters":{"type":"object","properties":{"portal_id":{"$ref":"#/components/schemas/UuidFieldFilter"},"portal_name":{"$ref":"#/components/schemas/StringFieldFilter"},"api_id":{"$ref":"#/components/schemas/UuidFieldFilter"},"api_name":{"$ref":"#/components/schemas/StringFieldFilter"},"auth_strategy_id":{"$ref":"#/components/schemas/UuidFieldFilter"},"entity_type":{"$ref":"#/components/schemas/StringFieldFilter"}},"title":"API Publication Filter Parameters"},"PortalApiPublicationFilterParameters":{"description":"API Publication filters excluding portal-specific fields (since portal is already specified in path)","type":"object","properties":{"api_id":{"$ref":"#/components/schemas/UuidFieldFilter"},"api_name":{"$ref":"#/components/schemas/StringFieldFilter"},"auth_strategy_id":{"$ref":"#/components/schemas/UuidFieldFilter"},"entity_type":{"$ref":"#/components/schemas/StringFieldFilter"}},"title":"Portal API Publication Filter Parameters"},"ApiImplementationFilterParameters":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/UuidFieldFilter"},"api_id":{"$ref":"#/components/schemas/UuidFieldFilter"},"service_id":{"$ref":"#/components/schemas/UuidFieldFilter"},"control_plane_id":{"$ref":"#/components/schemas/UuidFieldFilter"},"created_at":{"$ref":"#/components/schemas/DateTimeFieldFilter"},"updated_at":{"$ref":"#/components/schemas/DateTimeFieldFilter"}},"title":"API Implementation Filter Parameters"},"ApiAttributeFilterParameters":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/UuidFieldFilter"},"key":{"$ref":"#/components/schemas/UuidFieldFilter"},"created_at":{"$ref":"#/components/schemas/DateTimeFieldFilter"},"updated_at":{"$ref":"#/components/schemas/DateTimeFieldFilter"}},"title":"API Attribute Filter Parameters"},"ApiOperationFilterParameters":{"type":"object","properties":{"method":{"$ref":"#/components/schemas/StringFieldFilter"},"path":{"$ref":"#/components/schemas/StringFieldFilter"}},"title":"API Operation Filter Parameters"},"ApiPackageResponseSchema":{"type":"object","properties":{"id":{"description":"The API Package identifier.","type":"string","format":"uuid","example":"9f5061ce-78f6-4452-9108-ad7c02821fd5","readOnly":true},"name":{"description":"The name of your API Package. The `name + version` combination must be unique for each API Package you publish.\n","type":"string","example":"MyAPIPackage","maxLength":255,"minLength":1},"description":{"description":"A description of your API Package. Will be visible on your live Portal.","type":"string","nullable":true},"slug":{"description":"The unique slug for your API Package, It should be unique across all APIs and API Packages.\n","type":"string","example":"my-api-package-v1","nullable":true,"pattern":"^[\\w-]+$"},"version":{"description":"An optional version for your API Package. Leave this empty if your API Package is unversioned.","type":"string","maxLength":255,"minLength":1,"nullable":true},"rate_limiting_config":{"$ref":"#/components/schemas/RateLimitingConfig"},"labels":{"$ref":"#/components/schemas/Labels"},"attributes":{"$ref":"#/components/schemas/ApiAttributes"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"additionalProperties":false,"required":["id","name","slug","version","labels","attributes","created_at","updated_at","rate_limiting_config"],"title":"API Package"},"ApiPackageOperationResponseSchema":{"type":"object","properties":{"id":{"description":"The API Operation identifier.","type":"string","format":"uuid","example":"0f5061ce-78f6-4452-9108-ad7c02821fd6","readOnly":true},"api":{"type":"object","additionalProperties":false,"properties":{"id":{"description":"The API identifier.","type":"string","format":"uuid","example":"0f5061ce-78f6-4452-9108-ad7c02821fd6","readOnly":true},"name":{"description":"The name of the API this operation belongs to.","type":"string","example":"MyAPI","readOnly":true},"version":{"description":"The version of the API this operation belongs to.","type":"string","example":"1.0.0","readOnly":true}},"readOnly":true,"required":["id","name","version"]},"method":{"$ref":"#/components/schemas/Method"},"path":{"description":"The path of the API Operation.","type":"string","example":"/users/{user_id}","readOnly":true},"rate_limiting_config":{"description":"Rate limit configuration that can be applied to an API Package or an API Package Operation.","type":"object","additionalProperties":false,"nullable":true,"properties":{"limit":{"description":"The amount of requests allowed for each operation within the specified duration.","type":"integer","minimum":0},"duration":{"description":"The timeframe to ensure that an application does not exceed the request limit.","type":"string","enum":["seconds","minutes","hours"]}},"readOnly":true,"required":["limit","duration"],"title":"Rate Limiting configuration"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"},"implementation_status":{"$ref":"#/components/schemas/ApiOperationImplementationStatus"}},"additionalProperties":false,"required":["id","api","method","path","created_at","updated_at","rate_limiting_config"],"title":"API Package Operation Response"},"Method":{"description":"The HTTP method of an API Operation.","type":"string","enum":["GET","POST","PUT","DELETE","PATCH","OPTIONS","HEAD","CONNECT","TRACE"],"readOnly":true},"RateLimitingConfig":{"description":"Rate limit configuration that can be applied to an API Package or an API Package Operation.","type":"object","properties":{"limit":{"description":"The amount of requests allowed for each operation within the specified duration.","type":"integer","minimum":0},"duration":{"description":"The timeframe to ensure that an application does not exceed the request limit.","type":"string","enum":["seconds","minutes","hours"]}},"additionalProperties":false,"nullable":true,"required":["limit","duration"],"title":"Rate Limiting configuration"},"UuidFieldFilter":{"description":"Filter using **one** of the following operators: `eq`, `oeq`, `neq`","type":"object","properties":{"eq":{"description":"The field exactly matches the provided value.","type":"string","example":"?filter[field_name_here][eq]=foo"},"oeq":{"description":"The field matches any of the provided values.","type":"string","example":"?filter[field_name_here][oeq]=foo,bar"},"neq":{"description":"The field does not match the provided value.","type":"string","example":"?filter[field_name_here][neq]=bar"}},"additionalProperties":false,"x-examples":{"example-1":{"oeq":"some-value,some-other-value","neq":"not-this-value"},"example-2":{"eq":"some-value"}}},"StringFieldFilter":{"oneOf":[{"title":"Filter by operator","description":"Filter using **one** of the following operators: `eq`, `oeq`, `neq`, `contains`, `ocontains`","x-examples":{"example-1":{"contains":"some-value","ocontains":"this-value,or-that-value","oeq":"some-value,some-other-value","neq":"not-this-value"},"example-2":{"eq":"some-value"}},"properties":{"eq":{"description":"The field exactly matches the provided value.","type":"string","example":"?filter[field_name_here][eq]=foo"},"contains":{"description":"The field contains the provided value.","type":"string","example":"?filter[field_name_here][contains]=foo"},"ocontains":{"description":"The field contains any of the provided values.","type":"string","example":"?filter[field_name_here][ocontains]=foo,bar"},"oeq":{"description":"The field matches any of the provided values.","type":"string","example":"?filter[field_name_here][oeq]=foo,bar"},"neq":{"description":"The field does not match the provided value.","type":"string","example":"?filter[field_name_here][neq]=bar"}},"type":"object","additionalProperties":false},{"title":"Filter by exact string match","type":"string","description":"The field exactly matches the provided value.","example":"?filter[title]=foo"}]},"LabelsFieldFilter":{"allOf":[{"title":"LabelsFieldFilter","description":"Filters on the resource's `labels` field. Filters must use dot-notation to identify\nthe label key that will be used to filter the results. For example:\n  - `filter[labels.owner]`\n  - `filter[labels.owner][neq]=kong`\n  - `filter[labels.env]=dev`\n  - `filter[labels.env][ocontains]=dev,test`\n"},{"$ref":"#/components/schemas/StringFieldFilter"}]},"AttributesFieldFilter":{"allOf":[{"title":"AttributesFieldFilter","description":"Filters on the resource's `attributes` field. Filters must use dot-notation to identify\nthe attribute key that will be used to filter the results. For example:\n  - `filter[attributes.owner]`\n  - `filter[attributes.owner][neq]=kong`\n  - `filter[attributes.env]=dev`\n  - `filter[attributes.env][ocontains]=dev,test`\n"},{"$ref":"#/components/schemas/StringFieldFilter"}]},"DateTimeFieldFilter":{"description":"Filters on the given datetime (RFC-3339) field value.","oneOf":[{"type":"string","title":"DateTimeFieldImplicitEqualsFilter","format":"date-time","description":"Value strictly equals given RFC-3339 formatted timestamp in UTC","example":"2022-03-30T07:20:50Z"},{"type":"object","title":"DateTimeFieldEqualsFilter","additionalProperties":false,"properties":{"eq":{"description":"Value strictly equals given RFC-3339 formatted timestamp in UTC","type":"string","format":"date-time","example":"2022-03-30T07:20:50Z"}},"required":["eq"]},{"type":"object","title":"DateTimeFieldLTFilter","additionalProperties":false,"properties":{"lt":{"description":"Value is less than the given RFC-3339 formatted timestamp in UTC","type":"string","format":"date-time","example":"2022-03-30T07:20:50Z"}},"required":["lt"]},{"type":"object","title":"DateTimeFieldLTEFilter","additionalProperties":false,"properties":{"lte":{"description":"Value is less than or equal to the given RFC-3339 formatted timestamp in UTC","type":"string","format":"date-time","example":"2022-03-30T07:20:50Z"}},"required":["lte"]},{"type":"object","title":"DateTimeFieldGTFilter","additionalProperties":false,"properties":{"gt":{"description":"Value is greater than the given RFC-3339 formatted timestamp in UTC","type":"string","format":"date-time","example":"2022-03-30T07:20:50Z"}},"required":["gt"]},{"type":"object","title":"DateTimeFieldGTEFilter","additionalProperties":false,"properties":{"gte":{"description":"Value is greater than or equal to the given RFC-3339 formatted timestamp in UTC","type":"string","format":"date-time","example":"2022-03-30T07:20:50Z"}},"required":["gte"]}],"title":"DateTimeFieldFilter","x-examples":{"datetime_field_1":"2022-03-30T07:20:50Z","datetime_field_2":{"eq":"2022-03-30T07:20:50Z"},"datetime_field_3":{"lt":"2022-03-30T07:20:50Z"},"datetime_field_4":{"lte":"2022-03-30T07:20:50Z"},"datetime_field_5":{"gt":"2022-03-30T07:20:50Z"},"datetime_field_6":{"gte":"2022-03-30T07:20:50Z"}}},"SortQuery":{"description":"The `asc` suffix is optional as the default sort order is ascending.\nThe `desc` suffix is used to specify a descending order.\nMultiple sort attributes may be provided via a comma separated list.\nJSONPath notation may be used to specify a sub-attribute (eg: 'foo.bar desc').\n","type":"string","example":"created_at desc","title":"SortQuery"},"PageMeta":{"description":"Contains pagination query parameters and the total number of objects returned.","type":"object","properties":{"number":{"type":"number","example":1},"size":{"type":"number","example":10},"total":{"type":"number","example":100}},"required":["number","size","total"]},"PaginatedMeta":{"description":"returns the pagination information","type":"object","properties":{"page":{"$ref":"#/components/schemas/PageMeta"}},"required":["page"],"title":"PaginatedMeta"},"ApiSpecType":{"description":"The type of specification being stored. This allows us to render the specification correctly.\n","type":"string","example":"oas3","enum":["oas2","oas3","asyncapi"],"title":"API Spec Type"},"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},"Labels":{"description":"Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types. \n\nKeys must be of length 1-63 characters, and cannot start with \"kong\", \"konnect\", \"mesh\", \"kic\", or \"_\".\n","type":"object","example":{"env":"test"},"additionalProperties":{"type":"string","pattern":"^[a-z0-9A-Z]{1}([a-z0-9A-Z-._]*[a-z0-9A-Z]+)?$","minLength":1,"maxLength":63},"maxProperties":50,"title":"Labels"},"BaseError":{"description":"standard error","type":"object","properties":{"status":{"description":"The HTTP status code of the error. Useful when passing the response\nbody to child properties in a frontend UI. Must be returned as an integer.\n","type":"integer","readOnly":true},"title":{"description":"A short, human-readable summary of the problem. It should not\nchange between occurences of a problem, except for localization.\nShould be provided as \"Sentence case\" for direct use in the UI.\n","type":"string","readOnly":true},"type":{"description":"The error type.","type":"string","readOnly":true},"instance":{"description":"Used to return the correlation ID back to the user, in the format\nkong:trace:<correlation_id>. This helps us find the relevant logs\nwhen a customer reports an issue.\n","type":"string","readOnly":true},"detail":{"description":"A human readable explanation specific to this occurence of the problem.\nThis field may contain request/entity data to help the user understand\nwhat went wrong. Enclose variable values in square brackets. Should be\nprovided as \"Sentence case\" for direct use in the UI.\n","type":"string","readOnly":true}},"required":["status","title","instance","detail"],"title":"Error"},"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","type"],"nullable":true,"readOnly":true},"InvalidParameterStandard":{"type":"object","properties":{"field":{"type":"string","example":"name","readOnly":true},"rule":{"$ref":"#/components/schemas/InvalidRules"},"source":{"type":"string","example":"body"},"reason":{"type":"string","example":"is a required field","readOnly":true}},"additionalProperties":false,"required":["field","reason"]},"InvalidParameterMinimumLength":{"type":"object","properties":{"field":{"type":"string","example":"name","readOnly":true},"rule":{"description":"invalid parameters rules","type":"string","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","example":"body"},"reason":{"type":"string","example":"must have at least 8 characters","readOnly":true}},"additionalProperties":false,"required":["field","reason","rule","minimum"]},"InvalidParameterMaximumLength":{"type":"object","properties":{"field":{"type":"string","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":["field","reason","rule","maximum"]},"InvalidParameterChoiceItem":{"type":"object","properties":{"field":{"type":"string","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":["field","reason","rule","choices"]},"InvalidParameterDependentItem":{"type":"object","properties":{"field":{"type":"string","example":"name","readOnly":true},"rule":{"description":"invalid parameters rules","type":"string","enum":["dependent_fields"],"nullable":true,"readOnly":true},"reason":{"type":"string","example":"is a required field","readOnly":true},"dependents":{"type":"array","items":{},"nullable":true,"readOnly":true,"uniqueItems":true},"source":{"type":"string","example":"body"}},"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"}}}]},"UnauthorizedError":{"allOf":[{"$ref":"#/components/schemas/BaseError"},{"type":"object","properties":{"status":{"example":401},"title":{"example":"Unauthorized"},"type":{"example":"https://httpstatuses.com/401"},"instance":{"example":"kong:trace:1234567890"},"detail":{"example":"Invalid credentials"}}}]},"ForbiddenError":{"allOf":[{"$ref":"#/components/schemas/BaseError"},{"type":"object","properties":{"status":{"example":403},"title":{"example":"Forbidden"},"type":{"example":"https://httpstatuses.com/403"},"instance":{"example":"kong:trace:1234567890"},"detail":{"example":"Forbidden"}}}]},"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"}}}]},"UnsupportedMediaTypeError":{"allOf":[{"$ref":"#/components/schemas/BaseError"},{"type":"object","properties":{"status":{"example":415},"title":{"example":"UnsupportedMediaType"},"type":{"example":"https://httpstatuses.com/415"},"instance":{"example":"kong:trace:1234567890"},"detail":{"example":"UnsupportedMediaType"}}}]},"LabelsUpdate":{"description":"Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types. \n\nLabels are intended to store **INTERNAL** metadata.\n\nKeys must be of length 1-63 characters, and cannot start with \"kong\", \"konnect\", \"mesh\", \"kic\", or \"_\".\n","type":"object","example":{"env":"test"},"additionalProperties":{"type":"string","pattern":"^[a-z0-9A-Z]{1}([a-z0-9A-Z-._]*[a-z0-9A-Z]+)?$","minLength":1,"maxLength":63,"nullable":true},"maxProperties":50,"nullable":true,"writeOnly":true},"ConflictError":{"allOf":[{"$ref":"#/components/schemas/BaseError"},{"type":"object","properties":{"status":{"example":409},"title":{"example":"Conflict"},"type":{"example":"https://httpstatuses.com/409"},"instance":{"example":"kong:trace:1234567890"},"detail":{"example":"Conflict"}}}]},"EntityType":{"description":"The type of entity that is being published. Can be either an API or an API Package.","type":"string","example":"api","enum":["api","api_package"],"title":"Entity Type"},"UUID":{"description":"Contains a unique identifier used for this resource.","type":"string","format":"uuid","example":"5f9fd312-a987-4628-b4c5-bb4f4fddd5f7","readOnly":true}},"examples":{"ApiExample":{"value":{"id":"9f5061ce-78f6-4452-9108-ad7c02821fd5","name":"myAPI","version":"v1","labels":{"env":"test"},"description":"My API","created_at":"2023-01-01T00:00:00.000Z","updated_at":"2023-01-01T00:00:00.000Z","slug":"my-api-v1","current_version_summary":{"id":"7710d5c4-d902-410b-992f-18b814155b53","version":"v1","spec":{"type":"oas3"},"created_at":"2023-01-01T00:00:00.000Z","updated_at":"2023-01-01T00:00:00.000Z"},"portals":[{"id":"25a2624c-49fc-4764-99e1-224ed819f200","name":"My-Portal","display_name":"My Portal"}],"api_spec_ids":["123e4567-e89b-12d3-a456-426614174000"]}},"ApiPackageExample":{"value":{"id":"9f5061ce-78f6-4452-9108-ad7c02821fd5","name":"myAPIPackage","version":"v1","slug":"my-api-package-v1","description":"My API","rate_limiting_config":null,"created_at":"2023-01-01T00:00:00.000Z","updated_at":"2023-01-01T00:00:00.000Z","labels":{"foo":"bar"},"attributes":{"env":["production"]}}},"ApiPackageOperationExample":{"value":{"id":"4fa80de7-bce1-41e0-8788-8c5df14a23a0","api":{"id":"c9defa01-f239-4d88-8e4c-bfbf4096340b","name":"My Customer Api","version":"2.0.2"},"method":"POST","path":"/customers","rate_limiting_config":null,"created_at":"2026-12-02T08:00:06.040Z","updated_at":"2028-01-02T12:21:04.501Z"}},"ApiSpecExample":{"value":{"id":"7710d5c4-d902-410b-992f-18b814155b53","content":"{\"openapi\":\"3.0.3\",\"info\":{\"title\":\"Example API\",\"version\":\"1.0.0\"},\"paths\":{\"/example\":{\"get\":{\"summary\":\"Example endpoint\",\"responses\":{\"200\":{\"description\":\"Successful response\"}}}}}}","type":"oas3","validation_messages":[{"message":"'#/components/schemas/shouldExist' does not exist"}],"created_at":"2023-01-01T00:00:00.000Z","updated_at":"2023-01-01T00:00:00.000Z"}},"ApiSpecExampleAsyncApi":{"summary":"API Spec Response (AsyncAPI)","value":{"id":"8821e6d5-e013-411c-a03a-29c925266c64","content":"{\"asyncapi\":\"2.6.0\",\"info\":{\"title\":\"Account Service\",\"version\":\"1.0.0\",\"description\":\"This service is in charge of processing user signups\"},\"channels\":{\"user/signedup\":{\"publish\":{\"summary\":\"Inform about signed up users\",\"operationId\":\"sendUserSignedUp\",\"message\":{\"name\":\"UserSignedUp\",\"payload\":{\"type\":\"object\",\"properties\":{\"displayName\":{\"type\":\"string\",\"description\":\"Name of the user\"},\"email\":{\"type\":\"string\",\"format\":\"email\",\"description\":\"Email of the user\"}}}}}}}}","type":"asyncapi","validation_messages":[],"created_at":"2023-01-01T00:00:00.000Z","updated_at":"2023-01-01T00:00:00.000Z"}},"ApiVersionExample":{"value":{"id":"7710d5c4-d902-410b-992f-18b814155b53","version":"1.9.32","spec":{"content":"{\"openapi\":\"3.0.3\",\"info\":{\"title\":\"Example API\",\"version\":\"1.9.32\"},\"paths\":{\"/example\":{\"get\":{\"summary\":\"Example endpoint\",\"responses\":{\"200\":{\"description\":\"Successful response\"}}}}}}","type":"oas3","validation_messages":[{"message":"'#/components/schemas/shouldExist' does not exist"}]},"created_at":"2023-01-01T00:00:00.000Z","updated_at":"2023-01-01T00:00:00.000Z"}},"ApiVersionExampleAsyncApi":{"summary":"API Spec Response (AsyncAPI)","value":{"id":"8821e6d5-e013-411c-a03a-29c925266c64","version":"1.9.32","spec":{"content":"{\"asyncapi\":\"2.6.0\",\"info\":{\"title\":\"Account Service\",\"version\":\"1.9.32\",\"description\":\"This service is in charge of processing user signups\"},\"channels\":{\"user/signedup\":{\"publish\":{\"summary\":\"Inform about signed up users\",\"operationId\":\"sendUserSignedUp\",\"message\":{\"name\":\"UserSignedUp\",\"payload\":{\"type\":\"object\",\"properties\":{\"displayName\":{\"type\":\"string\",\"description\":\"Name of the user\"},\"email\":{\"type\":\"string\",\"format\":\"email\",\"description\":\"Email of the user\"}}}}}}}}","type":"asyncapi","validation_messages":[]},"created_at":"2023-01-01T00:00:00.000Z","updated_at":"2023-01-01T00:00:00.000Z"}},"ListApiSpecExample":{"value":{"data":[{"id":"7710d5c4-d902-410b-992f-18b814155b53","type":"oas3","created_at":"2023-01-01T00:00:00.000Z","updated_at":"2023-01-01T00:00:00.000Z"}],"meta":{"page":{"number":1,"size":1,"total":1}}}},"ListApiSpecExampleAsyncApi":{"summary":"List API Spec Response (Mixed Types)","value":{"data":[{"id":"7710d5c4-d902-410b-992f-18b814155b53","type":"oas3","created_at":"2023-01-01T00:00:00.000Z","updated_at":"2023-01-01T00:00:00.000Z"},{"id":"8821e6d5-e013-411c-a03a-29c925266c64","type":"asyncapi","created_at":"2023-01-02T00:00:00.000Z","updated_at":"2023-01-02T00:00:00.000Z"}],"meta":{"page":{"number":1,"size":2,"total":2}}}},"ListApiVersionExample":{"value":{"data":[{"id":"7710d5c4-d902-410b-992f-18b814155b53","spec":{"type":"oas3"},"version":"1.0.0","created_at":"2023-01-01T00:00:00.000Z","updated_at":"2023-01-01T00:00:00.000Z"}],"meta":{"page":{"number":1,"size":1,"total":1}}}},"ListApiVersionExampleAsyncApi":{"summary":"List API Version Response (Mixed Types)","value":{"data":[{"id":"7710d5c4-d902-410b-992f-18b814155b53","spec":{"type":"oas3"},"version":"1.0.0","created_at":"2023-01-01T00:00:00.000Z","updated_at":"2023-01-01T00:00:00.000Z"},{"id":"8821e6d5-e013-411c-a03a-29c925266c64","spec":{"type":"asyncapi"},"version":"1.0.1","created_at":"2023-01-02T00:00:00.000Z","updated_at":"2023-01-02T00:00:00.000Z"}],"meta":{"page":{"number":1,"size":2,"total":2}}}},"CreateApiRequestMinimalExample":{"summary":"Create API Request (Minimal)","value":{"name":"myAPI"}},"CreateApiRequestFullExample":{"summary":"Create API Request (Full)","value":{"name":"myAPI","version":"v1","slug":"my-api-v1","labels":{"env":"test"}}},"CreateApiSpecRequestExampleJson":{"summary":"Create API Specification Request (OAS3 JSON)","value":{"content":"{\"openapi\":\"3.0.3\",\"info\":{\"title\":\"Example API\",\"version\":\"1.0.0\"},\"paths\":{\"/example\":{\"get\":{\"summary\":\"Example endpoint\",\"responses\":{\"200\":{\"description\":\"Successful response\"}}}}}}","type":"oas3"}},"CreateApiSpecRequestExampleYaml":{"summary":"Create API Specification Request (OAS3 YAML)","value":{"content":"openapi: 3.0.3\\ninfo:\\n  title: Example API\\n  version: 1.0.0\\npaths:\\n  /example:\\n    get:\\n      summary: Example endpoint\\n      responses:\\n        \\\"200\\\":\\n          description: Successful response","type":"oas3"}},"CreateApiSpecRequestExampleAsyncApi":{"summary":"Create API Specification Request (AsyncAPI JSON)","value":{"content":"{\"asyncapi\":\"2.6.0\",\"info\":{\"title\":\"Account Service\",\"version\":\"1.0.0\",\"description\":\"This service is in charge of processing user signups\"},\"channels\":{\"user/signedup\":{\"publish\":{\"summary\":\"Inform about signed up users\",\"operationId\":\"sendUserSignedUp\",\"message\":{\"name\":\"UserSignedUp\",\"payload\":{\"type\":\"object\",\"properties\":{\"displayName\":{\"type\":\"string\",\"description\":\"Name of the user\"},\"email\":{\"type\":\"string\",\"format\":\"email\",\"description\":\"Email of the user\"}}}}}}}}","type":"asyncapi"}},"CreateApiVersionRequestExampleJson":{"summary":"Create API Version Request (OAS3 JSON)","value":{"version":"1.0.0","spec":{"content":"{\"openapi\":\"3.0.3\",\"info\":{\"title\":\"Example API\",\"version\":\"1.0.0\"},\"paths\":{\"/example\":{\"get\":{\"summary\":\"Example endpoint\",\"responses\":{\"200\":{\"description\":\"Successful response\"}}}}}}"}}},"CreateApiVersionRequestExampleYaml":{"summary":"Create API Version Request (OAS3 YAML)","value":{"version":"1.0.0","spec":{"content":"openapi: 3.0.3\\ninfo:\\n  title: Example API\\n  version: 1.0.0\\npaths:\\n  /example:\\n    get:\\n      summary: Example endpoint\\n      responses:\\n        \\\"200\\\":\\n          description: Successful response"}}},"CreateApiVersionRequestExampleAsyncApi":{"summary":"Create API Version Request (AsyncAPI JSON)","value":{"version":"1.0.0","spec":{"content":"{\"asyncapi\":\"2.6.0\",\"info\":{\"title\":\"Account Service\",\"version\":\"1.0.0\",\"description\":\"This service is in charge of processing user signups\"},\"channels\":{\"user/signedup\":{\"publish\":{\"summary\":\"Inform about signed up users\",\"operationId\":\"sendUserSignedUp\",\"message\":{\"name\":\"UserSignedUp\",\"payload\":{\"type\":\"object\",\"properties\":{\"displayName\":{\"type\":\"string\",\"description\":\"Name of the user\"},\"email\":{\"type\":\"string\",\"format\":\"email\",\"description\":\"Email of the user\"}}}}}}}}"}}},"UpdateApiNameRequestExample":{"summary":"Update API Name","value":{"name":"new API name"}},"UpdateApiVersionRequestExample":{"summary":"Update API Version","value":{"version":"v2"}},"UpdateApiSpecContentRequestExample":{"summary":"Update API Spec Content (OAS3)","value":{"content":"{\"openapi\":\"3.0.3\",\"info\":{\"title\":\"Example API\",\"version\":\"1.0.1\"},\"paths\":{\"/example\":{\"get\":{\"summary\":\"Example endpoint\",\"responses\":{\"200\":{\"description\":\"Successful response\"}}}}}}"}},"UpdateApiVersionContentRequestExample":{"summary":"Update API Version Content (OAS3)","value":{"version":"1.0.1","spec":{"content":"{\"openapi\":\"3.0.3\",\"info\":{\"title\":\"Example API\",\"version\":\"1.0.1\"},\"paths\":{\"/example\":{\"get\":{\"summary\":\"Example endpoint\",\"responses\":{\"200\":{\"description\":\"Successful response\"}}}}}}"}}},"ApiDocumentExample":{"value":{"id":"de5c9818-be5c-42e6-b514-e3d4bc30ddeb","parent_document_id":null,"title":"API Document","slug":"api-document","status":"published","content":"# API Document Header","created_at":"2023-01-01T00:00:00.000Z","updated_at":"2023-01-01T00:00:00.000Z"}},"CreateApiDocumentRequestExample":{"summary":"Create API Document Request","value":{"slug":"api-document","status":"published","title":"API Document","content":"# API Document Header","parent_document_id":"417a2aed-9a75-4eca-a943-fa7d88ed6a73"}},"CreateApiDocumentRequestMinimalExample":{"summary":"Create API Document Request (Minimal)","value":{"slug":"api-document","status":"published","title":"API Document","content":"# API Document Header"}},"UpdateApiDocumentAttributesRequestExample":{"summary":"Update API Document Attributes Request","value":{"parent_document_id":"dd4e1b98-3629-4dd3-acc0-759a726ffee2","slug":"api-document","status":"published","title":"API Document"}},"UpdateApiDocumentContentRequestExample":{"summary":"Update API Document Content Request","value":{"content":"# Updated API Document Header"}},"UpdateApiDocumentAttributesAndContentRequestExample":{"summary":"Update API Document Attributes and Content Request","value":{"parent_document_id":"dd4e1b98-3629-4dd3-acc0-759a726ffee2","slug":"api-document","status":"published","title":"API Document","content":"# Updated API Document Header"}},"CreateApiImplementationRequestExample":{"value":{"service":{"control_plane_id":"fd4e1b98-3629-4dd3-acc0-759a726ffee2","id":"dd4e1b98-3629-4dd3-acc0-759a726ffee2"}}},"ApiNameBadRequestExample":{"value":{"status":400,"title":"Invalid Request","instance":"kong:trace:8405749052424858251","detail":"Invalid Parameters","invalid_parameters":[{"field":"name","rule":"min_length","minimum":1,"reason":"name must be longer than or equal to 1 characters"}]}},"ApiDocumentBadRequestExample":{"value":{"status":400,"title":"Invalid Request","instance":"kong:trace:5832302153563197721","detail":"Invalid Parameters","invalid_parameters":[{"field":"slug","rule":"matches_regex","reason":"slug must match /^[\\w-]+$/ regular expression"}]}},"ApiSpecContentBadRequestExample":{"value":{"status":400,"title":"Invalid Request","instance":"kong:trace:1433447772874964729","detail":"Invalid Parameters","invalid_parameters":[{"field":"content","rule":"min_length","minimum":1,"reason":"content must be longer than or equal to 1 characters"}]}},"ApiVersionBadRequestExample":{"value":{"status":400,"title":"Invalid Request","instance":"kong:trace:1433447772874964729","detail":"Invalid Parameters","invalid_parameters":[{"field":"version","rule":"missing_reference","reason":"version must be provided if not included in spec_content"}]}},"ApiImplementationBadRequestExample":{"value":{"status":400,"title":"Invalid Request","instance":"kong:trace:1433447772874964729","detail":"Invalid Parameters","invalid_parameters":[{"field":"service.id","rule":"missing_reference","reason":"Service not found"}]}},"ApiUnauthorizedExample":{"value":{"status":401,"title":"ApiUnauthorized","instance":"kong:trace:8347343766220159418","detail":"ApiUnauthorized"}},"ApiNotFoundExample":{"value":{"status":404,"title":"Not Found","instance":"kong:trace:6816496025408232265","detail":"Not Found"}},"ApiForbiddenExample":{"value":{"status":403,"title":"ApiForbidden","instance":"kong:trace:2723154947768991354","detail":"You do not have permission to perform this action"}},"ApiSlugConflictExample":{"value":{"status":409,"title":"Conflict","instance":"kong:trace:3169213858331814220"}},"ApiSpecConflictExample":{"value":{"status":409,"title":"Conflict","instance":"kong:trace:3169213858331814220","detail":"Specification for API '9f5061ce-78f6-4452-9108-ad7c02821fd5' already exists"}},"ApiSpecHiddenConflictExample":{"value":{"status":409,"title":"Conflict","instance":"kong:trace:9039922446017540182","detail":"Key (api_id, path)=(23380be0-c15e-4ca8-bcf7-43aadddc91b1, hidden.yaml) already exists."}},"ApiOperationsRemovalConflictExample":{"value":{"status":409,"title":"Conflict","instance":"kong:trace:1234567890123456789","detail":"Operations are not allowed to be removed from the current version when using access control enforcement"}},"ApiImplementationServiceConflictExample":{"value":{"status":409,"title":"Conflict","instance":"kong:trace:3169213858331814220","detail":"This gateway service is already linked to another API"}},"ApiImplementationCountConflictExample":{"value":{"status":409,"title":"Conflict","instance":"kong:trace:3169213858331814220","detail":"An implementation already exists for this API"}},"InvalidApiSortQueryBadRequestExample":{"value":{"status":400,"title":"Invalid Request","instance":"kong:trace:4725061142075238974","detail":"Invalid Parameters","invalid_parameters":[{"field":"sort","rule":"enum","choices":["name"],"reason":"\"sort\" field must contain any of: [name]"}]}},"InvalidApiSortQueryNameBadRequestExample":{"value":{"status":400,"title":"Invalid Request","instance":"kong:trace:4725061142075238974","detail":"Invalid Parameters","invalid_parameters":[{"field":"sort","rule":"enum","choices":["name"],"reason":"\"sort\" field must contain any of: [name]"}]}},"ValidateApiSpecRequestExampleJson":{"summary":"Validate API Specification Request (OAS3 JSON)","value":{"content":"{\"openapi\":\"3.0.3\",\"info\":{\"title\":\"Valid API\",\"version\":\"1.0.0\"},\"paths\":{\"/health\":{\"get\":{\"summary\":\"Health check\",\"responses\":{\"200\":{\"description\":\"OK\"}}}}}}"}},"ValidateApiSpecRequestExampleYaml":{"summary":"Validate API Specification Request (OAS3 YAML)","value":{"content":"openapi: 3.0.3\\ninfo:\\n  title: Valid API\\n  version: 1.0.0\\npaths:\\n  /health:\\n    get:\\n      summary: Health check\\n      responses:\\n        '200':\\n          description: OK"}},"ValidateApiSpecRequestExampleAsyncApi":{"summary":"Validate API Specification Request (AsyncAPI JSON)","value":{"content":"{\"asyncapi\":\"2.6.0\",\"info\":{\"title\":\"Account Service\",\"version\":\"1.0.0\",\"description\":\"This service is in charge of processing user signups\"},\"channels\":{\"user/signedup\":{\"publish\":{\"summary\":\"Inform about signed up users\",\"operationId\":\"sendUserSignedUp\",\"message\":{\"name\":\"UserSignedUp\",\"payload\":{\"type\":\"object\",\"properties\":{\"displayName\":{\"type\":\"string\",\"description\":\"Name of the user\"},\"email\":{\"type\":\"string\",\"format\":\"email\",\"description\":\"Email of the user\"}}}}}}}}"}},"ValidateApiSpecSuccessResponseExample":{"summary":"Validate API Specification Success Response (No Warnings)","value":{"validation_messages":[]}},"ValidateApiSpecSuccessResponseWithWarningExample":{"summary":"Validate API Specification Success Response (With Warnings)","value":{"validation_messages":[{"message":"'#/components/schemas/shouldExist' does not exist"}]}},"ValidateApiSpecBadRequestExample":{"summary":"Validate API Specification Bad Request (Validation Failure)","value":{"status":400,"title":"Invalid Request","instance":"kong:trace:1234567890123456789","detail":"Invalid Parameters","validation_errors":[{"path":"#/info/title","message":"Field 'title' is required."},{"path":"#/paths/~1users/get/responses/200","message":"Response '200' requires a 'description'."}],"invalid_parameters":[{"field":"content","rule":"invalid","reason":"The provided specification content could not be parsed"}]}},"UpdateApiSpecContentRequestExampleAsyncApi":{"summary":"Update API Spec Content (AsyncAPI)","value":{"content":"{\"asyncapi\":\"2.6.0\",\"info\":{\"title\":\"Account Service Updated\",\"version\":\"1.0.1\",\"description\":\"This service is in charge of processing user signups (updated)\"},\"channels\":{\"user/signedup\":{\"publish\":{\"summary\":\"Inform about signed up users\",\"operationId\":\"sendUserSignedUp\",\"message\":{\"name\":\"UserSignedUp\",\"payload\":{\"type\":\"object\",\"properties\":{\"displayName\":{\"type\":\"string\",\"description\":\"Name of the user\"},\"email\":{\"type\":\"string\",\"format\":\"email\",\"description\":\"Email of the user\"}}}}}}}}","type":"asyncapi"}},"UpdateApiVersionContentRequestExampleAsyncApi":{"summary":"Update API Version Spec Content (AsyncAPI)","value":{"version":"1.0.2","spec":{"content":"{\"asyncapi\":\"2.6.0\",\"info\":{\"title\":\"Account Service Updated\",\"version\":\"1.0.1\",\"description\":\"This service is in charge of processing user signups (updated)\"},\"channels\":{\"user/signedup\":{\"publish\":{\"summary\":\"Inform about signed up users\",\"operationId\":\"sendUserSignedUp\",\"message\":{\"name\":\"UserSignedUp\",\"payload\":{\"type\":\"object\",\"properties\":{\"displayName\":{\"type\":\"string\",\"description\":\"Name of the user\"},\"email\":{\"type\":\"string\",\"format\":\"email\",\"description\":\"Email of the user\"}}}}}}}}"}}},"ApiOperationExample":{"summary":"API Operation Response","value":{"id":"b42d905a-ed33-46a3-a093-d8f536af9a8a","method":"GET","path":"/users/*"}},"ListApiOperationExample":{"summary":"List API Operations Response","value":{"data":[{"id":"b42d905a-ed33-46a3-a093-d8f536af9a8a","method":"GET","path":"/users/*"},{"id":"c53e206b-fe44-57b4-b094-e9f647bf0b9b","method":"POST","path":"/users"},{"id":"d64f317c-0f55-68c5-c1a5-f0f758cf1c0c","method":"DELETE","path":"/users/*"}],"meta":{"page":{"number":1,"size":3,"total":3}}}},"ListApiOperationWithImplementationStatusExample":{"summary":"List API Operations With Implementation Status Response","value":{"data":[{"id":"b42d905a-ed33-46a3-a093-d8f536af9a8a","method":"GET","path":"/users/*","implementation_status":{"matched":true,"route":{"id":"123e4567-e89b-12d3-a456-426614174000","name":"example-route"},"service":{"id":"123e4567-e89b-12d3-a456-426614174000","name":"example-service"}}},{"id":"c53e206b-fe44-57b4-b094-e9f647bf0b9b","method":"POST","path":"/users","implementation_status":{"matched":true,"route":{"id":"123e4567-e89b-12d3-a456-426614174000","name":"example-route"},"service":{"id":"123e4567-e89b-12d3-a456-426614174000","name":"example-service"}}},{"id":"d64f317c-0f55-68c5-c1a5-f0f758cf1c0c","method":"DELETE","path":"/users/*","implementation_status":{"matched":true,"route":{"id":"123e4567-e89b-12d3-a456-426614174000","name":"example-route"},"service":{"id":"123e4567-e89b-12d3-a456-426614174000","name":"example-service"}}}],"meta":{"page":{"number":1,"size":3,"total":3}}}},"UnsupportedMediaTypeExample":{"value":{"status":415,"title":"Unsupported Media Type","instance":"kong:trace:8347343766220159418","detail":"This API only supports requests with `Content-Type: application/json`"}}},"requestBodies":{"CreateApiRequest":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The API identifier.","type":"string","format":"uuid","example":"9f5061ce-78f6-4452-9108-ad7c02821fd5","readOnly":true},"name":{"description":"The name of your API. The `name + version` combination must be unique for each API you publish.\n","type":"string","example":"MyAPI","maxLength":255,"minLength":1},"description":{"description":"A description of your API. Will be visible on your live Portal.","type":"string","nullable":true},"version":{"description":"An optional version for your API. Leave this empty if your API is unversioned.","type":"string","maxLength":255,"minLength":1,"nullable":true},"current_version_summary":{"$ref":"#/components/schemas/ApiVersionSummary"},"slug":{"description":"The `slug` is used in generated URLs to provide human readable paths.\n\nDefaults to `slugify(name + version)`\n","type":"string","example":"my-api-v1","nullable":true,"pattern":"^[\\w-]+$"},"api_spec_ids":{"description":"The list of API specification ids for the API.","type":"array","items":{"type":"string","format":"uuid","description":"The id of the API specification.","example":"123e4567-e89b-12d3-a456-426614174000"},"deprecated":true,"readOnly":true},"portals":{"description":"The list of portals which this API is published to.","type":"array","items":{"type":"object","additionalProperties":false,"required":["id","name","display_name"],"properties":{"id":{"description":"The portal identifier.","type":"string","format":"uuid","example":"25a2624c-49fc-4764-99e1-224ed819f200"},"name":{"description":"The name of the portal, used to distinguish it from other portals.","type":"string","example":"My Portal"},"display_name":{"description":"The display name of the portal. This value will be the portal's `name` in Portal API.","type":"string","example":"My Portal"}}},"nullable":false,"readOnly":true,"uniqueItems":true},"labels":{"$ref":"#/components/schemas/Labels"},"implementation_mode":{"description":"the implementations that are associated with this api either gateway_entity_binding or access_control_enforcement","type":"string","nullable":true,"readOnly":true},"attributes":{"$ref":"#/components/schemas/ApiAttributes"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"},"spec_content":{"description":"The content of the API specification. This is the raw content of the API specification, in json or yaml. By including this field, you can add a API specification without having to make a separate call to update the API specification.","type":"string","nullable":false,"writeOnly":true}},"additionalProperties":false,"required":["name"],"title":"API"},"examples":{"CreateApiMinimal":{"$ref":"#/components/examples/CreateApiRequestMinimalExample"},"CreateApiFull":{"$ref":"#/components/examples/CreateApiRequestFullExample"}}}}},"CreateApiPackageRequest":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The API Package identifier.","type":"string","format":"uuid","example":"9f5061ce-78f6-4452-9108-ad7c02821fd5","readOnly":true},"name":{"description":"The name of your API Package. The `name + version` combination must be unique for each API Package you publish.\n","type":"string","example":"MyAPIPackage","maxLength":255,"minLength":1},"description":{"description":"A description of your API Package. Will be visible on your live Portal.","type":"string","nullable":true},"slug":{"description":"The unique slug for your API Package, It should be unique across all APIs and API Packages.\n","type":"string","example":"my-api-package-v1","nullable":true,"pattern":"^[\\w-]+$"},"version":{"description":"An optional version for your API Package. Leave this empty if your API Package is unversioned.","type":"string","maxLength":255,"minLength":1,"nullable":true},"rate_limiting_config":{"$ref":"#/components/schemas/RateLimitingConfig"},"labels":{"$ref":"#/components/schemas/Labels"},"attributes":{"$ref":"#/components/schemas/ApiAttributes"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"additionalProperties":false,"required":["name"],"title":"API Package"}}}},"CreateApiSpecRequest":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The API specification identifier.","type":"string","format":"uuid","example":"7710d5c4-d902-410b-992f-18b814155b53","readOnly":true},"content":{"description":"The raw content of your API specification, in json or yaml format (OpenAPI or AsyncAPI).\n","example":"{\"openapi\":\"3.0.3\",\"info\":{\"title\":\"Example API\",\"version\":\"1.0.0\"},\"paths\":{\"/example\":{\"get\":{\"summary\":\"Example endpoint\",\"responses\":{\"200\":{\"description\":\"Successful response\"}}}}}}","type":"string"},"validation_messages":{"description":"The errors that occurred while parsing the API specification.","type":"array","items":{"type":"object","additionalProperties":false,"required":["message"],"properties":{"message":{"type":"string"}}},"readOnly":true},"type":{"description":"The type of specification being stored. This allows us to render the specification correctly.\n","type":"string","example":"oas3","enum":["oas2","oas3","asyncapi"],"title":"API Spec Type"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"additionalProperties":false,"required":["content"],"title":"API Specification"},"examples":{"CreateApiSpecRequestExampleJson":{"$ref":"#/components/examples/CreateApiSpecRequestExampleJson"},"CreateApiSpecRequestExampleYaml":{"$ref":"#/components/examples/CreateApiSpecRequestExampleYaml"},"CreateApiSpecRequestExampleAsyncApi":{"$ref":"#/components/examples/CreateApiSpecRequestExampleAsyncApi"}}}}},"CreateApiVersionRequest":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The API version identifier.","type":"string","format":"uuid","example":"7710d5c4-d902-410b-992f-18b814155b53","readOnly":true},"version":{"description":"The version of the api.","type":"string","example":"1.0.0"},"spec":{"type":"object","additionalProperties":false,"properties":{"content":{"description":"The raw content of your API spec, in json or yaml format (OpenAPI or AsyncAPI).\n","example":"{\"openapi\":\"3.0.3\",\"info\":{\"title\":\"Example API\",\"version\":\"1.0.0\"},\"paths\":{\"/example\":{\"get\":{\"summary\":\"Example endpoint\",\"responses\":{\"200\":{\"description\":\"Successful response\"}}}}}}","type":"string"},"type":{"description":"The type of specification being stored. This allows us to render the specification correctly.\n","type":"string","example":"oas3","enum":["oas2","oas3","asyncapi"],"readOnly":true,"title":"API Spec Type"},"validation_messages":{"description":"The errors that occurred while parsing the API version spec.","type":"array","items":{"type":"object","additionalProperties":false,"required":["message"],"properties":{"message":{"type":"string"}}},"readOnly":true}}},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"additionalProperties":false,"required":["spec"],"title":"API Version"},"examples":{"CreateApiVersionRequestExampleJson":{"$ref":"#/components/examples/CreateApiVersionRequestExampleJson"},"CreateApiVersionRequestExampleYaml":{"$ref":"#/components/examples/CreateApiVersionRequestExampleYaml"},"CreateApiVersionRequestExampleAsyncApi":{"$ref":"#/components/examples/CreateApiVersionRequestExampleAsyncApi"}}}}},"CreateApiDocumentRequest":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ApiDocumentId"},"content":{"$ref":"#/components/schemas/ApiDocumentContent"},"title":{"$ref":"#/components/schemas/ApiDocumentTitle"},"slug":{"$ref":"#/components/schemas/ApiDocumentSlug"},"status":{"$ref":"#/components/schemas/ApiDocumentStatus"},"parent_document_id":{"$ref":"#/components/schemas/ApiDocumentParentDocumentId"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"additionalProperties":false,"required":["content"],"title":"API Document"},"examples":{"CreateApiDocumentRequestMinimalExample":{"$ref":"#/components/examples/CreateApiDocumentRequestMinimalExample"},"CreateApiDocumentRequestExample":{"$ref":"#/components/examples/CreateApiDocumentRequestExample"}}}}},"UpdateApiRequest":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The API identifier.","type":"string","format":"uuid","example":"9f5061ce-78f6-4452-9108-ad7c02821fd5","readOnly":true},"name":{"description":"The name of your API. The `name + version` combination must be unique for each API you publish.\n","type":"string","example":"MyAPI","maxLength":255,"minLength":1},"description":{"description":"A description of your API. Will be visible on your live Portal.","type":"string","nullable":true},"version":{"description":"An optional version for your API. Leave this empty if your API is unversioned.","type":"string","maxLength":255,"minLength":1,"nullable":true},"current_version_summary":{"$ref":"#/components/schemas/ApiVersionSummary"},"slug":{"description":"The `slug` is used in generated URLs to provide human readable paths.\n\nDefaults to `slugify(name + version)`\n","type":"string","example":"my-api-v1","nullable":true,"pattern":"^[\\w-]+$"},"api_spec_ids":{"description":"The list of API specification ids for the API.","type":"array","items":{"type":"string","format":"uuid","description":"The id of the API specification.","example":"123e4567-e89b-12d3-a456-426614174000"},"deprecated":true,"readOnly":true},"portals":{"description":"The list of portals which this API is published to.","type":"array","items":{"type":"object","additionalProperties":false,"required":["id","name","display_name"],"properties":{"id":{"description":"The portal identifier.","type":"string","format":"uuid","example":"25a2624c-49fc-4764-99e1-224ed819f200"},"name":{"description":"The name of the portal, used to distinguish it from other portals.","type":"string","example":"My Portal"},"display_name":{"description":"The display name of the portal. This value will be the portal's `name` in Portal API.","type":"string","example":"My Portal"}}},"nullable":false,"readOnly":true,"uniqueItems":true},"labels":{"$ref":"#/components/schemas/LabelsUpdate"},"implementation_mode":{"description":"the implementations that are associated with this api either gateway_entity_binding or access_control_enforcement","type":"string","nullable":true,"readOnly":true},"attributes":{"$ref":"#/components/schemas/ApiAttributes"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"additionalProperties":false,"title":"API"},"examples":{"UpdateApiName":{"$ref":"#/components/examples/UpdateApiNameRequestExample"},"UpdateApiVersion":{"$ref":"#/components/examples/UpdateApiVersionRequestExample"}}}}},"UpdateApiPackageRequest":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The API Package identifier.","type":"string","format":"uuid","example":"9f5061ce-78f6-4452-9108-ad7c02821fd5","readOnly":true},"name":{"description":"The name of your API Package. The `name + version` combination must be unique for each API Package you publish.\n","type":"string","example":"MyAPIPackage","maxLength":255,"minLength":1},"description":{"description":"A description of your API Package. Will be visible on your live Portal.","type":"string","nullable":true},"slug":{"description":"The unique slug for your API Package, It should be unique across all APIs and API Packages.\n","type":"string","example":"my-api-package-v1","nullable":true,"pattern":"^[\\w-]+$"},"version":{"description":"An optional version for your API Package. Leave this empty if your API Package is unversioned.","type":"string","maxLength":255,"minLength":1,"nullable":true},"rate_limiting_config":{"$ref":"#/components/schemas/RateLimitingConfig"},"labels":{"$ref":"#/components/schemas/LabelsUpdate"},"attributes":{"$ref":"#/components/schemas/ApiAttributes"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"additionalProperties":false,"title":"API Package"}}}},"UpdateApiPackageOperationRequest":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIPackageJSONPatchOperation"}}}},"UpdateApiDocumentRequest":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiDocument"},"examples":{"UpdateApiDocumentAttributes":{"$ref":"#/components/examples/UpdateApiDocumentAttributesRequestExample"},"UpdateApiDocumentContent":{"$ref":"#/components/examples/UpdateApiDocumentContentRequestExample"},"UpdateApiDocumentAttributesAndContent":{"$ref":"#/components/examples/UpdateApiDocumentAttributesAndContentRequestExample"}}}}},"UpdateApiSpecRequest":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiSpec"},"examples":{"UpdateApiSpecContentRequest":{"$ref":"#/components/examples/UpdateApiSpecContentRequestExample"},"UpdateApiSpecContentRequestAsyncApi":{"$ref":"#/components/examples/UpdateApiSpecContentRequestExampleAsyncApi"}}}}},"UpdateApiVersionRequest":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiVersion"},"examples":{"UpdateApiVersionContentRequest":{"$ref":"#/components/examples/UpdateApiVersionContentRequestExample"},"UpdateApiVersionContentRequestAsyncApi":{"$ref":"#/components/examples/UpdateApiVersionContentRequestExampleAsyncApi"}}}}},"PutApiPublicationRequest":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiPublication"}}}},"PutApiPackagePublicationRequest":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiPackagePublication"}}}},"CreateApiImplementationRequest":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiImplementation"},"examples":{"CreateApiImplementationRequest":{"$ref":"#/components/examples/CreateApiImplementationRequestExample"}}}}},"MoveDocumentRequest":{"required":true,"description":"move document","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MoveDocumentRequestPayload"}}}},"ValidateApiSpecRequest":{"required":true,"description":"Specification content and type for validation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidateApiSpecRequestPayload"},"examples":{"ValidateApiSpecRequestExampleJson":{"$ref":"#/components/examples/ValidateApiSpecRequestExampleJson"},"ValidateApiSpecRequestExampleYaml":{"$ref":"#/components/examples/ValidateApiSpecRequestExampleYaml"},"ValidateApiSpecRequestExampleAsyncApi":{"$ref":"#/components/examples/ValidateApiSpecRequestExampleAsyncApi"}}}}}},"responses":{"ApiSlugConflict":{"description":"Conflict - `slug` property must be unique","content":{"application/problem+json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"title":{"type":"string"},"type":{"type":"string"},"instance":{"type":"string"}},"required":["status","title","instance"]},"examples":{"ApiSlugConflictExample":{"$ref":"#/components/examples/ApiSlugConflictExample"}}}}},"ApiSpecConflict":{"description":"Conflict - An API may only have one specification","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConflictError"},"examples":{"ApiSpecConflictExample":{"$ref":"#/components/examples/ApiSpecConflictExample"}}}}},"ApiSpecHiddenConflict":{"description":"Conflict - name attribute must be unique across specifications","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConflictError"},"examples":{"ApiSpecConflictExample":{"$ref":"#/components/examples/ApiSpecHiddenConflictExample"}}}}},"ApiVersionPatchConflict":{"description":"Conflict - May occur when constraints are violated","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConflictError"},"examples":{"ApiOperationsRemovalConflictExample":{"$ref":"#/components/examples/ApiOperationsRemovalConflictExample"},"ApiSpecHiddenConflictExample":{"$ref":"#/components/examples/ApiSpecHiddenConflictExample"}}}}},"ApiImplementationConflict":{"description":"Conflict - A gateway service can only be linked to a single API","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConflictError"},"examples":{"ApiImplementationServiceConflictExample":{"$ref":"#/components/examples/ApiImplementationServiceConflictExample"},"ApiImplementationCountConflictExample":{"$ref":"#/components/examples/ApiImplementationCountConflictExample"}}}}},"ApiUnauthorized":{"description":"ApiUnauthorized","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"},"examples":{"ApiUnauthorizedExample":{"$ref":"#/components/examples/ApiUnauthorizedExample"}}}}},"ApiNotFound":{"description":"Not Found","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/NotFoundError"},"examples":{"ApiNotFoundExample":{"$ref":"#/components/examples/ApiNotFoundExample"}}}}},"ApiForbidden":{"description":"ApiForbidden","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"},"examples":{"ApiForbiddenExample":{"$ref":"#/components/examples/ApiForbiddenExample"}}}}},"ApiPublicationBadRequest":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}}},"ApiResponse":{"description":"API","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseSchema"},"examples":{"CreateApiResponse":{"$ref":"#/components/examples/ApiExample"}}}}},"ListApiResponse":{"description":"List of APIs","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/PaginatedMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ApiResponseSchema"}}},"additionalProperties":false,"required":["data","meta"],"title":"ListApiResponse"},"examples":{"ApiCollection":{"value":{"data":[{"id":"9f5061ce-78f6-4452-9108-ad7c02821fd5","name":"myAPI","version":"v1","labels":{"env":"test"},"slug":"my-api-v1","current_version_summary":{"id":"7710d5c4-d902-410b-992f-18b814155b53","version":"v1","spec":{"type":"oas3"},"created_at":"2023-01-01T00:00:00.000Z","updated_at":"2023-01-01T00:00:00.000Z"},"api_spec_ids":["123e4567-e89b-12d3-a456-426614174000"],"portals":[{"id":"25a2624c-49fc-4764-99e1-224ed819f200","name":"My-Portal","display_name":"My Portal"}],"created_at":"2023-01-01T00:00:00.000Z","updated_at":"2023-01-01T00:00:00.000Z"}],"meta":{"page":{"number":1,"size":1,"total":10}}}}}}}},"ApiPackageResponse":{"description":"API Package","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiPackageResponseSchema"},"examples":{"ApiPackageResponse":{"$ref":"#/components/examples/ApiPackageExample"}}}}},"ApiPackageOperationResponse":{"description":"API Package Operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiPackageOperationResponseSchema"},"examples":{"ApiPackageResponse":{"$ref":"#/components/examples/ApiPackageOperationExample"}}}}},"ListApiPackagesResponse":{"description":"List of API Packages","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/PaginatedMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ApiPackageResponseSchema"}}},"additionalProperties":false,"required":["data","meta"],"title":"ListApiPackagesResponse"},"examples":{"ApiPackageCollection":{"value":{"data":[{"id":"9f5061ce-78f6-4452-9108-ad7c02821fd5","name":"myAPIPackage","version":"v1","slug":"my-api-package-v1","description":"This is an API package","rate_limiting_config":null,"labels":{"env":"test"},"attributes":{"env":["production"]},"created_at":"2023-01-01T00:00:00.000Z","updated_at":"2023-01-01T00:00:00.000Z"}],"meta":{"page":{"number":1,"size":1,"total":10}}}}}}}},"ListApiPackagesOperationsResponse":{"description":"List of API Package Operations","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/PaginatedMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ApiPackageOperationResponseSchema"}}},"additionalProperties":false,"required":["data","meta"],"title":"ListApiPackageOperationsResponse"},"examples":{"ApiPackageCollection":{"value":{"data":[{"id":"c9d02086-14bb-4e2e-8d40-991bf3fef9ce","api":{"id":"830413b1-ac8e-4e71-a260-c1ba9ab33089","name":"My User Api","version":"2.0.2"},"method":"GET","path":"/users","rate_limiting_config":{"limit":3600,"duration":"seconds"},"created_at":"2026-12-02T08:00:06.040Z","updated_at":"2028-01-02T12:21:04.501Z"},{"id":"4fa80de7-bce1-41e0-8788-8c5df14a23a0","api":{"id":"c9defa01-f239-4d88-8e4c-bfbf4096340b","name":"My Customer Api","version":"2.0.2"},"method":"POST","path":"/customers","rate_limiting_config":null,"created_at":"2026-12-02T08:00:06.040Z","updated_at":"2028-01-02T12:21:04.501Z"}],"meta":{"page":{"number":1,"size":10,"total":2}}}}}}}},"ApiPackageDocumentResponse":{"description":"API Package document","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ApiDocumentId"},"content":{"$ref":"#/components/schemas/ApiDocumentContent"},"title":{"$ref":"#/components/schemas/ApiDocumentTitle"},"slug":{"$ref":"#/components/schemas/ApiDocumentSlug"},"status":{"$ref":"#/components/schemas/ApiDocumentStatus"},"parent_document_id":{"$ref":"#/components/schemas/ApiDocumentParentDocumentId"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"additionalProperties":false,"required":["id","parent_document_id","title","slug","status","content","updated_at","created_at"],"title":"API Document"},"examples":{"CreateApiDocumentResponse":{"$ref":"#/components/examples/ApiDocumentExample"}}}}},"ApiDocumentResponse":{"description":"API document","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ApiDocumentId"},"content":{"$ref":"#/components/schemas/ApiDocumentContent"},"title":{"$ref":"#/components/schemas/ApiDocumentTitle"},"slug":{"$ref":"#/components/schemas/ApiDocumentSlug"},"status":{"$ref":"#/components/schemas/ApiDocumentStatus"},"parent_document_id":{"$ref":"#/components/schemas/ApiDocumentParentDocumentId"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"additionalProperties":false,"required":["id","parent_document_id","title","slug","status","content","updated_at","created_at"],"title":"API Document"},"examples":{"CreateApiDocumentResponse":{"$ref":"#/components/examples/ApiDocumentExample"}}}}},"ListApiPackageDocumentResponse":{"description":"List of API Package documents","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ApiDocumentSummaryWithChildren"}}},"additionalProperties":false,"required":["data"]}}}},"ListApiDocumentResponse":{"description":"List of API documents","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ApiDocumentSummaryWithChildren"}}},"additionalProperties":false,"required":["data"]}}}},"ApiSpecResponse":{"description":"API specification (OpenAPI or AsyncAPI)","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The API specification identifier.","type":"string","format":"uuid","example":"7710d5c4-d902-410b-992f-18b814155b53","readOnly":true},"content":{"description":"The raw content of your API specification, in json or yaml format (OpenAPI or AsyncAPI).\n","example":"{\"openapi\":\"3.0.3\",\"info\":{\"title\":\"Example API\",\"version\":\"1.0.0\"},\"paths\":{\"/example\":{\"get\":{\"summary\":\"Example endpoint\",\"responses\":{\"200\":{\"description\":\"Successful response\"}}}}}}","type":"string"},"validation_messages":{"description":"The errors that occurred while parsing the API specification.","type":"array","items":{"type":"object","additionalProperties":false,"required":["message"],"properties":{"message":{"type":"string"}}},"readOnly":true},"type":{"description":"The type of specification being stored. This allows us to render the specification correctly.\n","type":"string","example":"oas3","enum":["oas2","oas3","asyncapi"],"title":"API Spec Type"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"additionalProperties":false,"required":["id","content","type","created_at","updated_at","validation_messages"],"title":"API Specification"},"examples":{"ApiSpecResponse":{"$ref":"#/components/examples/ApiSpecExample"},"ApiSpecResponseAsyncApi":{"$ref":"#/components/examples/ApiSpecExampleAsyncApi"}}}}},"ListApiSpecResponse":{"description":"List of API specifications (OpenAPI or AsyncAPI)","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/PaginatedMeta"},"data":{"type":"array","items":{"title":"API Specification Summary","type":"object","additionalProperties":false,"properties":{"id":{"description":"The API specification identifier.","type":"string","format":"uuid","example":"7710d5c4-d902-410b-992f-18b814155b53","readOnly":true},"type":{"$ref":"#/components/schemas/ApiSpecType"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"required":["id","type","created_at","updated_at"]}}},"additionalProperties":false,"required":["data","meta"],"title":"ListApiSpecResponse"},"examples":{"ListApiSpecResponse":{"$ref":"#/components/examples/ListApiSpecExample"},"ListApiSpecResponseAsyncApi":{"$ref":"#/components/examples/ListApiSpecExampleAsyncApi"}}}}},"ApiVersionResponse":{"description":"API version (OpenAPI or AsyncAPI)","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The API version identifier.","type":"string","format":"uuid","example":"7710d5c4-d902-410b-992f-18b814155b53","readOnly":true},"version":{"description":"The version of the api.","type":"string","example":"1.0.0"},"spec":{"type":"object","additionalProperties":false,"properties":{"content":{"description":"The raw content of your API spec, in json or yaml format (OpenAPI or AsyncAPI).\n","example":"{\"openapi\":\"3.0.3\",\"info\":{\"title\":\"Example API\",\"version\":\"1.0.0\"},\"paths\":{\"/example\":{\"get\":{\"summary\":\"Example endpoint\",\"responses\":{\"200\":{\"description\":\"Successful response\"}}}}}}","type":"string"},"type":{"description":"The type of specification being stored. This allows us to render the specification correctly.\n","type":"string","example":"oas3","enum":["oas2","oas3","asyncapi"],"readOnly":true,"title":"API Spec Type"},"validation_messages":{"description":"The errors that occurred while parsing the API version spec.","type":"array","items":{"type":"object","additionalProperties":false,"required":["message"],"properties":{"message":{"type":"string"}}},"readOnly":true}}},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"additionalProperties":false,"required":["id","version","created_at","updated_at"],"title":"API Version"},"examples":{"ApiSpecResponse":{"$ref":"#/components/examples/ApiVersionExample"},"ApiSpecResponseAsyncApi":{"$ref":"#/components/examples/ApiVersionExampleAsyncApi"}}}}},"ListApiVersionResponse":{"description":"List of API specifications (OpenAPI or AsyncAPI)","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/PaginatedMeta"},"data":{"type":"array","items":{"title":"API Version Summary","type":"object","additionalProperties":false,"readOnly":true,"nullable":false,"properties":{"id":{"description":"The API version identifier.","type":"string","format":"uuid","example":"7710d5c4-d902-410b-992f-18b814155b53","readOnly":true},"version":{"description":"The version of this api spec.","type":"string"},"spec":{"type":"object","additionalProperties":false,"properties":{"type":{"$ref":"#/components/schemas/ApiSpecType"}}},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"required":["id","version","created_at","updated_at"]}}},"additionalProperties":false,"required":["data","meta"],"title":"ListApiSpecResponse"},"examples":{"ListApiSpecResponse":{"$ref":"#/components/examples/ListApiVersionExample"},"ListApiSpecResponseAsyncApi":{"$ref":"#/components/examples/ListApiVersionExampleAsyncApi"}}}}},"ApiPublicationResponse":{"description":"An API publication in a portal","content":{"application/json":{"schema":{"description":"An API publication in a portal","type":"object","properties":{"auto_approve_registrations":{"$ref":"#/components/schemas/AutoApproveRegistrations"},"auth_strategy_ids":{"$ref":"#/components/schemas/ApiPublicationAuthStrategyIds"},"visibility":{"$ref":"#/components/schemas/ApiPublicationVisibility"},"warnings":{"description":"Informational warnings (e.g. incompatible fields stripped for ACE). Empty if none.","type":"array","items":{"type":"string"},"readOnly":true},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"additionalProperties":false,"required":["visibility","created_at","updated_at","auth_strategy_ids"],"title":"API Publication"}}}},"ListApiPublicationResponse":{"description":"Paginated list of API publications","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/PaginatedMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ApiPublicationListItem"}}},"additionalProperties":false,"required":["data","meta"],"title":"ListApiPublications"}}}},"ListPublicationResponse":{"description":"Paginated list of publications","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/PaginatedMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/PublicationListItem"}}},"additionalProperties":false,"required":["data","meta"],"title":"ListPublications"}}}},"ApiPackagePublicationResponse":{"description":"An API Package publication in a portal","content":{"application/json":{"schema":{"description":"An API Package publication in a portal","type":"object","properties":{"auto_approve_registrations":{"$ref":"#/components/schemas/AutoApproveRegistrations"},"auth_strategy_ids":{"$ref":"#/components/schemas/ApiPublicationAuthStrategyIds"},"visibility":{"$ref":"#/components/schemas/ApiPublicationVisibility"},"warnings":{"description":"Informational warnings (e.g. incompatible fields stripped for ACE). Empty if none.","type":"array","items":{"type":"string"},"readOnly":true},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"additionalProperties":false,"required":["visibility","created_at","updated_at","auth_strategy_ids"],"title":"API Package Publication"}}}},"ApiImplementationResponse":{"description":"An API implementation","content":{"application/json":{"schema":{"description":"An entity that implements an API","type":"object","oneOf":[{"$ref":"#/components/schemas/ApiImplementationGatewayServiceEntity"},{"$ref":"#/components/schemas/ApiImplementationControlPlaneEntity"}],"required":["id","created_at","updated_at"],"title":"API Implementation"}}}},"ListApiImplementationsResponse":{"description":"Paginated list of API implementations","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/PaginatedMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ApiImplementationListItem"}}},"additionalProperties":false,"required":["data","meta"],"title":"ListApiImplementations"}}}},"ListApiAttributesResponse":{"description":"Paginated list of API attributes","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/PaginatedMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ApiAttributeListItem"}}},"additionalProperties":false,"required":["data","meta"],"title":"ListApiAttributes"}}}},"ValidateApiSpecSuccessResponse":{"description":"API specification (OpenAPI or AsyncAPI) validation successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidateApiSpecSuccessResponse"},"examples":{"ValidateApiSpecSuccessResponseExample":{"$ref":"#/components/examples/ValidateApiSpecSuccessResponseExample"},"ValidateApiSpecSuccessResponseWithWarningExample":{"$ref":"#/components/examples/ValidateApiSpecSuccessResponseWithWarningExample"}}}}},"ApiOperationResponse":{"description":"An API operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiOperation"},"examples":{"ApiOperationExample":{"$ref":"#/components/examples/ApiOperationExample"}}}}},"ListApiOperationResponse":{"description":"Paginated list of API operations","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/PaginatedMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ApiOperation"}}},"additionalProperties":false,"required":["data","meta"],"title":"ListApiOperations"},"examples":{"ListApiOperationExample":{"$ref":"#/components/examples/ListApiOperationExample"},"ListApiOperationWithImplementationStatusExample":{"$ref":"#/components/examples/ListApiOperationWithImplementationStatusExample"}}}}},"UnsupportedMediaType":{"description":"Unsupported Media Type","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/UnsupportedMediaTypeError"},"examples":{"UnsupportedMediaTypeExample":{"$ref":"#/components/examples/UnsupportedMediaTypeExample"}}}}},"Conflict":{"description":"Conflict","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConflictError"}}}}},"securitySchemes":{"konnectAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The Konnect access token is meant to be used by the Konnect dashboard and the decK CLI authenticate with.\n"},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"Token","description":"The personal access token is meant to be used as an alternative to basic-auth when accessing Konnect via APIs.\nYou can generate a Personal Access Token (PAT) from the [personal access token page](https://cloud.konghq.com/global/account/tokens/) in the Konnect dashboard.\nThe PAT token must be passed in the header of a request, for example:\n`curl -X GET 'https://global.api.konghq.com/v2/users/' --header 'Authorization: Bearer kpat_xgfT...'`\n"},"systemAccountAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"Token","description":"The system account access token is meant for automations and integrations that are not directly associated with a human identity.\nYou can generate a system account Access Token by creating a system account and then obtaining a system account access token for that account.\nThe access token must be passed in the header of a request, for example:\n`curl -X GET 'https://global.api.konghq.com/v2/users/' --header 'Authorization: Bearer spat_i2Ej...'`\n"}}},"tags":[{"name":"API"},{"name":"API Documentation"},{"name":"API Specification"},{"name":"API Publication"},{"name":"API Implementation"},{"name":"API Operations"},{"name":"API Attributes"},{"name":"API Packages"},{"name":"API Package Operations"},{"name":"API Package Documentation"}],"security":[{"konnectAccessToken":[]},{"personalAccessToken":[]},{"systemAccountAccessToken":[]}]}
```
