---
title: "Portal Products"
url: "https://nov18-dev.movespot.fyi/apis/portal-products-2/versions/e27f19d8-63a7-4a90-88ab-02bc91b51306"
---

# Portal Products

OpenAPI specification document.

```json
{"openapi":"3.0.3","info":{"title":"Portal Products","version":"2.0.0","description":"N/A (this description is removed during bundling)","contact":{"name":"Kong","url":"https://cloud.konghq.com"}},"paths":{"/api/v2/products/{productId}":{"get":{"operationId":"get-product","summary":"Get a product","description":"Gets the details for an existing published product.","parameters":[{"$ref":"#/components/parameters/ProductId"}],"responses":{"200":{"$ref":"#/components/responses/ProductGet"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"portalAccessToken":[]},{}],"tags":["products"]}},"/api/v2/products":{"get":{"operationId":"list-products","summary":"List Products","description":"Returns a paginated list of published API Products.","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"},{"$ref":"#/components/parameters/FilterByNameEquality"},{"$ref":"#/components/parameters/FilterByNameEqualityShort"},{"$ref":"#/components/parameters/FilterByNameContains"},{"$ref":"#/components/parameters/FilterByDescriptionEquality"},{"$ref":"#/components/parameters/FilterByDescriptionEqualityShort"},{"$ref":"#/components/parameters/FilterByDescriptionContains"},{"$ref":"#/components/parameters/FilterByIdEquality"},{"$ref":"#/components/parameters/FilterByIdEqualityShort"}],"responses":{"200":{"$ref":"#/components/responses/ProductList"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"}},"security":[{"portalAccessToken":[]},{}],"tags":["products"]}},"/api/v2/products/{productId}/versions":{"get":{"operationId":"list-product-versions","summary":"Get page of product versions","description":"Returns paginated list of versions of a given product.","parameters":[{"$ref":"#/components/parameters/ProductId"},{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"},{"$ref":"#/components/parameters/FilterByNameEquality"},{"$ref":"#/components/parameters/FilterByNameEqualityShort"},{"$ref":"#/components/parameters/FilterByNameContains"}],"responses":{"200":{"$ref":"#/components/responses/ProductListVersions"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"portalAccessToken":[]},{}],"tags":["versions"]}},"/api/v2/products/{productId}/versions/{productVersionId}":{"get":{"operationId":"get-product-version","summary":"Get product version","description":"Gets the details for an existing product version.","parameters":[{"$ref":"#/components/parameters/ProductId"},{"$ref":"#/components/parameters/ProductVersionId"}],"responses":{"200":{"$ref":"#/components/responses/ProductVersionGet"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"portalAccessToken":[]},{}],"tags":["versions"]}},"/api/v2/products/{productId}/versions/{productVersionId}/applications":{"get":{"operationId":"get-applications-by-product-version","summary":"Get applications by product version","description":"Get applications that have a registration for a given product version. Any registration for the version will count, regardless of status (i.e. even if it is pending, rejected, or revoked).\nUse the `unregistered` query param to return the inverse, only including applicatons that do not have a registration (regardless of status).","parameters":[{"$ref":"#/components/parameters/ProductId"},{"$ref":"#/components/parameters/ProductVersionId"},{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"},{"$ref":"#/components/parameters/FilterByNameEquality"},{"$ref":"#/components/parameters/FilterByNameEqualityShort"},{"$ref":"#/components/parameters/FilterByNameContains"},{"$ref":"#/components/parameters/FilterByStatusEquality"},{"$ref":"#/components/parameters/FilterByStatusEqualityShort"},{"$ref":"#/components/parameters/FilterByAuthStrategyEquality"},{"$ref":"#/components/parameters/FilterByAuthStrategyEqualityShort"},{"$ref":"#/components/parameters/QueryUnregisteredApplications"}],"responses":{"200":{"$ref":"#/components/responses/ProductVersionListApplications"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"portalAccessToken":[]}],"tags":["versions"]}},"/api/v2/products/{productId}/versions/{productVersionId}/spec":{"get":{"operationId":"get-product-version-spec","summary":"Get spec for product version","description":"Returns the API specification document attached to given product version. Currently only OpenAPI is supported.","parameters":[{"$ref":"#/components/parameters/ProductId"},{"$ref":"#/components/parameters/ProductVersionId"}],"responses":{"200":{"$ref":"#/components/responses/ProductVersionSpecGet"},"204":{"description":"No specification is defined for the version."},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"portalAccessToken":[]},{}],"tags":["versions"]}},"/api/v2/products/{productId}/versions/{productVersionId}/spec/operations":{"get":{"operationId":"get-product-version-spec-operations","summary":"Get operations in version spec","description":"Returns list of operations used in the API specification document attached to given product version.","parameters":[{"$ref":"#/components/parameters/ProductId"},{"$ref":"#/components/parameters/ProductVersionId"}],"responses":{"200":{"$ref":"#/components/responses/ProductVersionSpecOperationsGet"},"204":{"description":"Response when there are no operations to send because no spec is defined for the version."},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"portalAccessToken":[]},{}],"tags":["versions"]}},"/api/v2/products/{productId}/documents":{"get":{"operationId":"list-product-documents","summary":"List product documents","description":"Returns a list of documents that are associated with a given product. The list is paginated, and is in either a list or tree format (based on the Accept header).","parameters":[{"$ref":"#/components/parameters/ProductId"},{"name":"Accept","in":"header","schema":{"$ref":"#/components/schemas/DocumentContentTypeEnum"}},{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"}],"responses":{"200":{"description":"Lists documents for a given product.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListDocuments"}},"application/vnd.konnect.document-tree+json":{"schema":{"$ref":"#/components/schemas/ListDocumentsTree"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"portalAccessToken":[]},{}],"tags":["documentation"]}},"/api/v2/products/{productId}/documents/{documentId}":{"get":{"operationId":"get-product-document","summary":"Get one product document","description":"Returns the specified document from the product's document tree.","parameters":[{"name":"Accept","in":"header","schema":{"$ref":"#/components/schemas/DocumentFormatContentTypeEnum"}},{"$ref":"#/components/parameters/ProductId"},{"$ref":"#/components/parameters/DocumentId"}],"responses":{"200":{"$ref":"#/components/responses/ProductDocumentGet"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"portalAccessToken":[]},{}],"tags":["documentation"]}},"/api/v2/products/{productId}/actions":{"parameters":[{"$ref":"#/components/parameters/ProductId"}],"get":{"operationId":"get-product-actions","summary":"Get Product Actions","description":"Get a list of actions that the current developer is allowed to perform on an API product.","responses":{"200":{"$ref":"#/components/responses/ProductActions"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"503":{"$ref":"#/components/responses/NotAvailable"}},"tags":["products"]}}},"components":{"parameters":{"DocumentId":{"schema":{"type":"string","format":"uuid","example":"d32d905a-ed33-46a3-a093-d8f536af9a8a"},"name":"documentId","in":"path","required":true,"description":"ID of the document."},"FilterByAuthStrategyEquality":{"name":"filter[auth_strategy_id][eq]","description":"Filter by the id of the auth strategy supported by the application.","in":"query","required":false,"schema":{"type":"string","example":"5be86298-147b-45ab-bfaf-a1bff97dce39"}},"FilterByAuthStrategyEqualityShort":{"name":"filter[auth_strategy_id]","description":"Filter by the id of the auth strategy supported by the application (short-hand).","in":"query","required":false,"schema":{"type":"string","example":"5be86298-147b-45ab-bfaf-a1bff97dce39"}},"FilterByDescriptionContains":{"name":"filter[description][contains]","description":"Filter by contains comparison of the description property with a supplied substring","in":"query","required":false,"schema":{"type":"string","example":"portal"}},"FilterByDescriptionEquality":{"name":"filter[description][eq]","description":"Filter by direct equality comparison of the description property with a supplied value.","in":"query","required":false,"schema":{"type":"string","example":"portal"}},"FilterByDescriptionEqualityShort":{"name":"filter[description]","description":"Filter by direct equality comparison (short-hand) of the description property with a supplied value.","in":"query","required":false,"schema":{"type":"string","example":"portal"}},"FilterByIdEquality":{"name":"filter[id][eq]","description":"Filter by direct equality comparison of the id property with a supplied value.","in":"query","required":false,"schema":{"type":"string","example":"5be86298-147b-45ab-bfaf-a1bff97dce39"}},"FilterByIdEqualityShort":{"name":"filter[id]","description":"Filter by direct equality comparison (short-hand) of the id property with a supplied value.","in":"query","required":false,"schema":{"type":"string","example":"5be86298-147b-45ab-bfaf-a1bff97dce39"}},"FilterByNameContains":{"name":"filter[name][contains]","description":"Filter by contains comparison of the name property with a supplied substring","in":"query","required":false,"schema":{"type":"string","example":"good service"}},"FilterByNameEquality":{"name":"filter[name][eq]","description":"Filter by direct equality comparison of the name property with a supplied value.","in":"query","required":false,"schema":{"type":"string","example":"good service"}},"FilterByNameEqualityShort":{"name":"filter[name]","description":"Filter by direct equality comparison (short-hand) of the name property with a supplied value.","in":"query","required":false,"schema":{"type":"string","example":"good service"}},"FilterByStatusEquality":{"name":"filter[status][eq]","description":"Filter by direct equality comparison of the status property with a supplied value.","in":"query","required":false,"schema":{"type":"string","example":"approved","enum":["approved","pending","rejected","revoked"]}},"FilterByStatusEqualityShort":{"name":"filter[status]","description":"Filter by direct equality comparison (short-hand) of the status property with a supplied value.","in":"query","required":false,"schema":{"type":"string","example":"approved","enum":["approved","pending","rejected","revoked"]}},"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}},"ProductId":{"name":"productId","in":"path","required":true,"description":"Contains a unique identifier used by the Portal API for this resource.","schema":{"type":"string","format":"uuid"}},"ProductVersionId":{"name":"productVersionId","in":"path","required":true,"description":"Contains a unique identifier used by the Portal API for this resource.","schema":{"type":"string","format":"uuid"}},"QueryUnregisteredApplications":{"name":"unregistered","description":"Return applications that do **not** have a registration for the product version (regardless of registration status).","in":"query","required":false,"schema":{"type":"boolean"},"allowEmptyValue":true}},"schemas":{"ProductActionsResponse":{"type":"object","properties":{"actions":{"description":"List of actions that can be performed on the API Product","type":"object","additionalProperties":false,"properties":{"view":{"type":"boolean"},"register":{"type":"boolean"},"view_documentation":{"type":"boolean"}},"required":["view","register","view_documentation"]}},"example":{"actions":{"view":true,"register":false,"view_documentation":true}},"additionalProperties":false,"required":["actions"],"title":"Product Actions Response"},"Product":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/UUID"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"},"name":{"description":"Name of product.","type":"string","example":"Billing"},"description":{"type":"string","example":"API for billing functions","nullable":true},"document_count":{"description":"Number of linked documents in documentation.","type":"integer","example":3,"readOnly":true},"version_count":{"description":"Number of published versions.","type":"integer","example":2,"readOnly":true},"latest_version":{"$ref":"#/components/schemas/LatestVersion"},"public_labels":{"$ref":"#/components/schemas/PublicLabels"}},"additionalProperties":false,"required":["id","public_labels","created_at","updated_at","name"],"title":"Product"},"ProductListPage":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/PaginatedMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Product"}}},"title":"ProductListPage"},"ProductVersion":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/UUID"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"},"name":{"description":"Name of product version.","type":"string","example":"v2.0.0"},"deprecated":{"description":"If true, product version is deprecated.","type":"boolean"},"registration_configs":{"description":"Configurations for how the product version is able to be registered for by applications.","type":"array","items":{"$ref":"#/components/schemas/RegistrationConfiguration"}}},"additionalProperties":false,"required":["id","created_at","updated_at","name","deprecated","registration_configs"]},"RegistrationConfiguration":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/UUID"},"auth_methods":{"type":"array","items":{"description":"Auth Methods enabled for this strategy","type":"string"},"example":["bearer"]},"credential_type":{"$ref":"#/components/schemas/CredentialType"},"name":{"type":"string"},"available_scopes":{"$ref":"#/components/schemas/AvailableScopes"},"registration_enabled":{"description":"If true, application registration is allowed for this configuration.","type":"boolean","example":true},"registration_auto_approve":{"description":"If true, applications are automatically approved for registration.","type":"boolean","example":false}},"additionalProperties":false,"required":["id","name","credential_type","registration_enabled","registration_auto_approve"]},"CredentialType":{"type":"string","enum":["client_credentials","self_managed_client_credentials","key_auth"]},"LatestVersion":{"type":"object","properties":{"name":{"type":"string","example":"v2.0.0","readOnly":true},"id":{"$ref":"#/components/schemas/UUID"}},"additionalProperties":false,"nullable":true},"ProductVersionListPage":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/PaginatedMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ProductVersion"}}},"additionalProperties":false,"required":["meta","data"],"title":"ProductVersionListPage"},"ProductVersionListApplicationsPage":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/PaginatedMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ProductVersionApplication"}}},"additionalProperties":false,"required":["meta","data"],"title":"ProductVersionListApplicationsPage"},"ProductVersionApplication":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/UUID"},"name":{"description":"The name of the application","type":"string"},"registration_id":{"$ref":"#/components/schemas/NullableUUID"},"registration_status":{"type":"string","enum":["approved","pending","rejected","revoked"],"nullable":true},"auth_strategy":{"$ref":"#/components/schemas/AuthStrategy"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"additionalProperties":false,"required":["id","name","created_at","updated_at","registration_status","registration_id"],"title":"ProductVersionApplication"},"ProductVersionSpecDocument":{"description":"API specification document for a product version.","type":"object","properties":{"api_type":{"$ref":"#/components/schemas/ApiTypeEnum"},"content":{"type":"string"}},"required":["api_type","content"],"title":"ProductVersionSpecDocument"},"ProductVersionSpecOperations":{"description":"List of every operation detailed in a product version spec document.","type":"object","properties":{"api_type":{"$ref":"#/components/schemas/ApiTypeEnum"},"operations":{"type":"array","items":{"type":"object","required":["path","method","operation_id","tags","summary","deprecated"],"properties":{"path":{"type":"string","example":"/pet"},"method":{"type":"string","example":"post"},"operation_id":{"type":"string","example":"addPet","nullable":true},"tags":{"type":"array","items":{"type":"string","example":"pet"}},"summary":{"type":"string","example":"Add a new Pet to the store","nullable":true},"deprecated":{"type":"boolean"}}}}},"required":["api_type","operations"],"title":"ProductVersionSpecOperations"},"ApiTypeEnum":{"type":"string","enum":["openapi"]},"ProductDocument":{"description":"A document for a product. This is a document that is not a part of the API specification.","type":"object","properties":{"id":{"allOf":[{"$ref":"#/components/schemas/UUID"},{"description":"Contains a unique identifier used by the DocumentHub service for this resource.","type":"string"}]},"parent_document_id":{"description":"Contains a unique identifier used by the DocumentHub service for this resource.","type":"string","format":"uuid","example":"dd4e1b98-3629-4dd3-acc0-759a726ffee2","nullable":true},"slug":{"description":"Slug of the document. This is used in the URL to identify the document.","type":"string","example":"getting-started"},"content":{"$ref":"#/components/schemas/DocumentBlock"},"title":{"description":"Title of the document. This is used in the Portal UI to identify the document.","type":"string","example":"Hello World"}},"required":["id","slug","title","content"],"title":"ProductDocument"},"ProductDocumentRaw":{"description":"A document for a product. This is a document that is not a part of the API specification.","type":"object","properties":{"id":{"allOf":[{"$ref":"#/components/schemas/UUID"},{"description":"Contains a unique identifier used by the DocumentHub service for this resource.","type":"string"}]},"parent_document_id":{"description":"Contains a unique identifier used by the DocumentHub service for this resource.","type":"string","format":"uuid","example":"dd4e1b98-3629-4dd3-acc0-759a726ffee2","nullable":true},"slug":{"description":"Slug of the document. This is used in the URL to identify the document.","type":"string","example":"getting-started"},"content":{"description":"Markdown document","example":"# My Kong api\n\nThis api is powered by Konnect\n","type":"string"},"title":{"description":"Title of the document. This is used in the Portal UI to identify the document.","type":"string","example":"Hello World"}},"required":["id","slug","title","content"],"title":"ProductDocumentRaw"},"UUID":{"description":"Contains a unique identifier used for this resource.","type":"string","format":"uuid","example":"5f9fd312-a987-4628-b4c5-bb4f4fddd5f7","readOnly":true},"CreatedAt":{"description":"An ISO-8601 timestamp representation of entity creation date.","type":"string","format":"date-time","example":"2022-11-04T20:10:06.927Z","readOnly":true},"UpdatedAt":{"description":"An ISO-8601 timestamp representation of entity update date.","type":"string","format":"date-time","example":"2022-11-04T20:10:06.927Z","readOnly":true},"PublicLabels":{"description":"Public labels store information about an entity that can be used for filtering a list of objects.\n\nPublic labels are intended to store **PUBLIC** metadata. \n\nKeys must be of length 1-63 characters, and cannot start with \"kong\", \"konnect\", \"mesh\", \"kic\", or \"_\".\n","type":"object","example":{"category":"finance"},"additionalProperties":{"type":"string","pattern":"^[a-z0-9A-Z]{1}([a-z0-9A-Z-._]*[a-z0-9A-Z]+)?$","minLength":1,"maxLength":63},"maxProperties":50,"title":"PublicLabels"},"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"}}}]},"NotFoundError":{"allOf":[{"$ref":"#/components/schemas/BaseError"},{"type":"object","properties":{"status":{"example":404},"title":{"example":"Not Found"},"type":{"example":"https://httpstatuses.com/404"},"instance":{"example":"kong:trace:1234567890"},"detail":{"example":"Not found"}}}]},"PageMeta":{"description":"Contains pagination query parameters and the total number of objects returned.","type":"object","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"},"AvailableScopes":{"description":"Possible developer selectable scopes for an application. Only present when using DCR Provider that supports it.","type":"array","items":{"type":"string"},"example":["scope1","scope2"]},"NullableUUID":{"description":"Contains a unique identifier for a resource.","type":"string","format":"uuid","example":"5f9fd312-a987-4628-b4c5-bb4f4fddd5f7","nullable":true},"AuthStrategyKeyAuth":{"description":"KeyAuth Auth strategy that the application uses.","type":"object","properties":{"id":{"description":"The Application Auth Strategy ID.","type":"string","format":"uuid","example":"b9e81174-b5bb-4638-a3c3-8afe61a0abf8","readOnly":true},"name":{"type":"string","example":"name","default":"name"},"credential_type":{"type":"string","enum":["key_auth"]},"key_names":{"type":"array","items":{"type":"string"}},"ttl":{"description":"Default maximum Time-To-Live for keys created under this strategy.","type":"object","properties":{"value":{"type":"integer","minimum":1},"unit":{"type":"string","enum":["days","weeks","years"]}},"required":["value","unit"]}},"additionalProperties":false,"required":["id","name","credential_type","key_names"]},"AuthMethods":{"type":"array","items":{"description":"Auth Methods enabled for this strategy","type":"string"},"example":["bearer"]},"AuthStrategyClientCredentials":{"description":"Client Credential Auth strategy that the application uses.","type":"object","properties":{"id":{"description":"The Application Auth Strategy ID.","type":"string","format":"uuid","example":"b9e81174-b5bb-4638-a3c3-8afe61a0abf8","readOnly":true},"name":{"type":"string","example":"name","default":"name"},"credential_type":{"type":"string","enum":["client_credentials","self_managed_client_credentials"]},"auth_methods":{"$ref":"#/components/schemas/AuthMethods"},"available_scopes":{"$ref":"#/components/schemas/AvailableScopes"}},"additionalProperties":false,"required":["id","name","credential_type","auth_methods"]},"AuthStrategy":{"type":"object","discriminator":{"propertyName":"credential_type"},"oneOf":[{"$ref":"#/components/schemas/AuthStrategyKeyAuth"},{"$ref":"#/components/schemas/AuthStrategyClientCredentials"}]},"DocumentContentTypeEnum":{"type":"string","default":"application/json","enum":["application/json","application/vnd.konnect.document-tree+json"]},"Metadata":{"description":"Contains key value pairs information about entity's metadata.","type":"object","example":{"owner":"John Appleseed"},"additionalProperties":true},"DocumentItem":{"type":"object","properties":{"id":{"description":"the id of the document","type":"string","format":"uuid","example":"d32d905a-ed33-46a3-a093-d8f536af9a8a"},"parent_document_id":{"description":"the id of the parent document","type":"string","format":"uuid","example":"dd4e1b98-3629-4dd3-acc0-759a726ffee2","nullable":true},"slug":{"description":"the slug of the document","type":"string","example":"getting-started"},"title":{"description":"the title of the document","type":"string","example":"Getting Started"},"metadata":{"$ref":"#/components/schemas/Metadata"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"additionalProperties":false,"required":["id","parent_document_id","slug","title","metadata","created_at","updated_at"],"title":"Document item"},"ListDocuments":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/PaginatedMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/DocumentItem"}}},"additionalProperties":false,"required":["meta","data"]},"DocumentTree":{"description":"a document tree","type":"object","properties":{"id":{"type":"string","format":"uuid","example":"d32d905a-ed33-46a3-a093-d8f536af9a8a"},"parent_document_id":{"type":"string","format":"uuid","example":"dd4e1b98-3629-4dd3-acc0-759a726ffee2","nullable":true},"title":{"description":"the title of the document","type":"string","example":"Getting Started"},"slug":{"description":"the slug of the document","type":"string","example":"getting-started"},"metadata":{"$ref":"#/components/schemas/Metadata"},"children":{"type":"array","items":{"$ref":"#/components/schemas/DocumentTree"}},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"required":["id","title","slug","metadata","children","created_at","updated_at"],"title":"DocumentTree"},"ListDocumentsTree":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/PaginatedMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/DocumentTree"}}},"required":["meta","data"]},"DocumentFormatContentTypeEnum":{"type":"string","default":"application/json","enum":["text/markdown","application/json","application/vnd.konnect.document-nodes+json"]},"NodeChildren":{"description":"List of children nodes of the current node","type":"array","items":{"$ref":"#/components/schemas/ChildNode"}},"HeadingBlock":{"type":"object","properties":{"type":{"type":"string","enum":["heading"]},"level":{"description":"Level of the heading which maps to HTML <h> tag","type":"number","maximum":6,"minimum":1},"children":{"$ref":"#/components/schemas/NodeChildren"}},"required":["type"]},"BlockQuoteBlock":{"type":"object","properties":{"type":{"type":"string","enum":["blockquote"]},"children":{"$ref":"#/components/schemas/NodeChildren"}},"required":["type"]},"ParagraphBlock":{"type":"object","properties":{"type":{"type":"string","enum":["paragraph"]},"children":{"$ref":"#/components/schemas/NodeChildren"}},"required":["type"]},"TextBlock":{"type":"object","properties":{"type":{"type":"string","enum":["text_block"]},"children":{"$ref":"#/components/schemas/NodeChildren"}},"required":["type"]},"BreakBlock":{"type":"object","properties":{"type":{"type":"string","enum":["break"]},"children":{"$ref":"#/components/schemas/NodeChildren"}},"required":["type"]},"CodeBlock":{"type":"object","properties":{"type":{"type":"string","enum":["code_block"]},"lang":{"type":"string"},"children":{"$ref":"#/components/schemas/NodeChildren"}},"required":["type"]},"ListBlock":{"type":"object","properties":{"type":{"type":"string","enum":["list"]},"isOrdered":{"description":"Defines if the list is ordered or not","type":"boolean"},"children":{"$ref":"#/components/schemas/NodeChildren"}},"required":["type"]},"ListItemBlock":{"type":"object","properties":{"type":{"type":"string","enum":["list_item"]},"children":{"$ref":"#/components/schemas/NodeChildren"}},"required":["type"]},"Text":{"type":"object","properties":{"type":{"type":"string","enum":["text"]},"text":{"type":"string"},"hardBreak":{"description":"If this property is true the end of this block should\nbe a carriage return and not concatenated to the next Text block.\n","type":"boolean"},"softBreak":{"description":"If this property is true the end of this block should should be\nconcatenated with a space caracter before the next block. This is\nthe flag showing that the parsed markdown block was at the end of\nthe line.\n","type":"boolean"},"children":{"$ref":"#/components/schemas/NodeChildren"}},"required":["type"]},"Emphasis":{"type":"object","properties":{"type":{"type":"string","enum":["emphasis"]},"level":{"description":"Level of emphasis\n1 - italic\n2 - bold\n","type":"number","maximum":2,"minimum":1},"children":{"$ref":"#/components/schemas/NodeChildren"}},"required":["type"]},"Code":{"type":"object","properties":{"type":{"type":"string","enum":["code"]},"children":{"$ref":"#/components/schemas/NodeChildren"}},"required":["type"]},"Link":{"type":"object","properties":{"type":{"type":"string","enum":["link"]},"href":{"description":"Target url of the link","type":"string"},"title":{"description":"Title of the link","type":"string"}},"required":["type"]},"Image":{"type":"object","properties":{"type":{"type":"string","enum":["image"]},"url":{"description":"Url of the image","type":"string"},"alt":{"description":"Alternate tag of the image","type":"string"},"title":{"description":"Title of the image","type":"string"}},"required":["type"]},"StrikeThrough":{"type":"object","properties":{"type":{"type":"string","enum":["strikethrough"]}},"required":["type"]},"AlignmentKind":{"type":"string","enum":["left","right","center","none"]},"TableAlignments":{"type":"array","items":{"$ref":"#/components/schemas/AlignmentKind"},"nullable":true},"TableBlock":{"type":"object","properties":{"type":{"type":"string","enum":["table"]},"alignments":{"$ref":"#/components/schemas/TableAlignments"},"children":{"$ref":"#/components/schemas/NodeChildren"}},"required":["type","alignments"]},"TableHeaderBlock":{"type":"object","properties":{"type":{"type":"string","enum":["table_header"]},"alignments":{"$ref":"#/components/schemas/TableAlignments"},"children":{"$ref":"#/components/schemas/NodeChildren"}},"required":["type","alignments"]},"TableCellBlock":{"type":"object","properties":{"type":{"type":"string","enum":["table_cell"]},"alignment":{"$ref":"#/components/schemas/AlignmentKind"},"children":{"$ref":"#/components/schemas/NodeChildren"}},"required":["type"]},"TableRowBlock":{"type":"object","properties":{"type":{"type":"string","enum":["table_row"]},"alignments":{"$ref":"#/components/schemas/TableAlignments"},"children":{"$ref":"#/components/schemas/NodeChildren"}},"required":["type","alignments"]},"TaskCheckbox":{"type":"object","properties":{"type":{"type":"string","enum":["task_checkbox"]},"checked":{"description":"State of the checkbox","type":"boolean"}},"required":["checked","type"]},"ChildNode":{"type":"object","discriminator":{"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/HeadingBlock"},{"$ref":"#/components/schemas/BlockQuoteBlock"},{"$ref":"#/components/schemas/ParagraphBlock"},{"$ref":"#/components/schemas/TextBlock"},{"$ref":"#/components/schemas/BreakBlock"},{"$ref":"#/components/schemas/CodeBlock"},{"$ref":"#/components/schemas/ListBlock"},{"$ref":"#/components/schemas/ListItemBlock"},{"$ref":"#/components/schemas/Text"},{"$ref":"#/components/schemas/Emphasis"},{"$ref":"#/components/schemas/Code"},{"$ref":"#/components/schemas/Link"},{"$ref":"#/components/schemas/Image"},{"$ref":"#/components/schemas/StrikeThrough"},{"$ref":"#/components/schemas/TableBlock"},{"$ref":"#/components/schemas/TableHeaderBlock"},{"$ref":"#/components/schemas/TableCellBlock"},{"$ref":"#/components/schemas/TableRowBlock"},{"$ref":"#/components/schemas/TaskCheckbox"}]},"DocumentBlock":{"description":"content of the document","type":"object","properties":{"type":{"type":"string","enum":["document"]},"version":{"type":"string"},"children":{"$ref":"#/components/schemas/NodeChildren"}},"example":{"type":"document","content":[{"type":"paragraph","content":[{"text":"Hello World","type":"text"}]}]},"required":["type"]}},"examples":{"ProductActionsExample":{"value":{"actions":{"register":false,"view":true,"view_documentation":true}}},"UnauthorizedExample":{"value":{"status":401,"title":"Unauthorized","instance":"kong:trace:8347343766220159418","detail":"Unauthorized"}},"NotFoundExample":{"value":{"status":404,"title":"Not Found","instance":"kong:trace:6816496025408232265","detail":"Not Found"}}},"responses":{"ProductActions":{"description":"Product actions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductActionsResponse"},"examples":{"Retrieve Product Actions Response":{"$ref":"#/components/examples/ProductActionsExample"}}}}},"ProductGet":{"description":"Response for a single product's details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Product"}}}},"ProductList":{"description":"Response for a list of products.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductListPage"}}}},"ProductListVersions":{"description":"Paginated list of versions of an API Product.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductVersionListPage"}}}},"ProductVersionGet":{"description":"Product version details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductVersion"}}}},"ProductVersionListApplications":{"description":"Paginated list of applications either registered or not registered for a product version.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductVersionListApplicationsPage"}}}},"ProductVersionSpecGet":{"description":"Product version spec document.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductVersionSpecDocument"}}}},"ProductVersionSpecOperationsGet":{"description":"Product version spec operations.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductVersionSpecOperations"}}}},"ProductDocumentGet":{"description":"Details for a single document for a given product.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductDocumentRaw"}},"application/vnd.konnect.document-nodes+json":{"schema":{"$ref":"#/components/schemas/ProductDocument"}}}},"BadRequest":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}}},"Unauthorized":{"description":"Unauthorized","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"},"examples":{"UnauthorizedExample":{"$ref":"#/components/examples/UnauthorizedExample"}}}}},"NotFound":{"description":"Not Found","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/NotFoundError"},"examples":{"NotFoundExample":{"$ref":"#/components/examples/NotFoundExample"}}}}},"NotAvailable":{"description":"Service not available","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BaseError"}}}}},"securitySchemes":{"portalAccessToken":{"type":"apiKey","in":"cookie","name":"portalaccesstoken","description":"The Developer portal cookie is meant to be used by the Developer API to authenticate with.\n"}}},"tags":[{"name":"products","description":"The API for Konnect Portal Products."},{"name":"versions","description":"The API for Konnect Portal Product Versions."},{"name":"documentation","description":"The API for Konnect Portal API Documentation."}]}
```
