openapi: 3.1.0
info:
  contact:
    email: support@konghq.com
    name: Kong Inc
    url: https://konghq.com
  description: 'OpenAPI 3.0 spec for Kong Gateway''s Admin API.


    You can learn more about Kong Gateway at [developer.konghq.com](https://developer.konghq.com).

    Give Kong a star at the [Kong/kong](https://github.com/kong/kong) repository.'
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  title: Kong Enterprise Admin ACLs API Publication API
  version: 3.14.0
servers:
- description: Default Admin API URL
  url: '{protocol}://{hostname}:{port}{path}'
  variables:
    hostname:
      default: localhost
      description: Hostname for Kong's Admin API
    path:
      default: /
      description: Base path for Kong's Admin API
    port:
      default: '8001'
      description: Port for Kong's Admin API
    protocol:
      default: http
      description: Protocol for requests to Kong's Admin API
      enum:
      - http
      - https
security:
- adminToken: []
tags:
- name: API Publication
paths:
  /v3/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.

        '
      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.

        If the API Package is not published to the portal, a 404 response is returned.

        '
      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
  /v3/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
  /v3/apis/{apiId}/publications/{portalId}:
    parameters:
    - $ref: '#/components/parameters/ApiId'
    - $ref: '#/components/parameters/PortalId'
    put:
      x-speakeasy-entity-operation:
        terraform-resource: ApiPublication#create,update
        terraform-datasource: null
      operationId: publish-api-to-portal
      summary: Publish API
      description: 'Publish an API to a portal.

        '
      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:
      x-speakeasy-entity-operation:
        terraform-resource: ApiPublication#read
        terraform-datasource: null
      operationId: fetch-publication
      summary: Get a Publication
      description: 'Retrieve an API''s publication in a portal.

        If the API is not published to the portal, a 404 response is returned.

        '
      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:
      x-speakeasy-entity-operation:
        terraform-resource: ApiPublication#delete
        terraform-datasource: null
      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
  /v3/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.


        **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.

        '
      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
components:
  schemas:
    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
          x-speakeasy-unknown-values: allow
        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
    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
      x-speakeasy-param-suppress-computed-diff: true
    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
    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
          x-speakeasy-unknown-values: allow
        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
    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
        oeq:
          description: The field matches any of the provided values.
          type: string
        neq:
          description: The field does not match the provided value.
          type: string
      additionalProperties: false
    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
    ApiPublicationAuthStrategyIds:
      description: 'The auth strategy the API enforces for applications in the portal.

        Omitting this property means the portal''s default application auth strategy will be used.

        Setting to null means the API will not require application authentication.

        DCR support for application registration is currently in development.

        '
      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
    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
    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
    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
    PaginatedMeta:
      description: returns the pagination information
      type: object
      properties:
        page:
          $ref: '#/components/schemas/PageMeta'
      required:
      - page
      title: PaginatedMeta
      x-speakeasy-terraform-ignore: true
    StringFieldFilter:
      description: 'Filter using **one** of the following operators: `eq`, `oeq`, `neq`, `contains`, `ocontains`'
      type: object
      properties:
        eq:
          description: The field exactly matches the provided value.
          type: string
        contains:
          description: The field contains the provided value.
          type: string
        ocontains:
          description: The field contains any of the provided values.
          type: string
        oeq:
          description: The field matches any of the provided values.
          type: string
        neq:
          description: The field does not match the provided value.
          type: string
      additionalProperties: false
    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
      x-speakeasy-param-suppress-computed-diff: true
    BaseError:
      description: standard error
      type: object
      properties:
        status:
          description: 'The HTTP status code of the error. Useful when passing the response

            body to child properties in a frontend UI. Must be returned as an integer.

            '
          type: integer
          readOnly: true
        title:
          description: 'A short, human-readable summary of the problem. It should not

            change between occurences of a problem, except for localization.

            Should be provided as "Sentence case" for direct use in the UI.

            '
          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

            kong:trace:<correlation_id>. This helps us find the relevant logs

            when a customer reports an issue.

            '
          type: string
          readOnly: true
        detail:
          description: 'A human readable explanation specific to this occurence of the problem.

            This field may contain request/entity data to help the user understand

            what went wrong. Enclose variable values in square brackets. Should be

            provided as "Sentence case" for direct use in the UI.

            '
          type: string
          readOnly: true
      required:
      - status
      - title
      - instance
      - detail
      title: Error
    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
    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
    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
    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
      x-speakeasy-unknown-values: allow
    SortQuery:
      description: 'The `asc` suffix is optional as the default sort order is ascending.

        The `desc` suffix is used to specify a descending order.

        Multiple sort attributes may be provided via a comma separated list.

        JSONPath notation may be used to specify a sub-attribute (eg: ''foo.bar desc'').

        '
      type: string
      example: created_at desc
      title: SortQuery
    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
    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'
    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
    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
      x-speakeasy-unknown-values: allow
    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
    ApiPublicationVisibility:
      description: 'The visibility of the API in the portal.

        Public API publications do not require authentication to view and retrieve information about them.

        Private API publications require authentication to retrieve information about them.

        '
      type: string
      default: private
      enum:
      - public
      - private
      title: API Publication Visibility
      x-speakeasy-unknown-values: allow
    PageMeta:
      description: Contains pagination query parameters and the total number of objects returned.
      type: object
      properties:
        number:
          type: number
          example: 1
          x-speakeasy-terraform-ignore: true
        size:
          type: number
          example: 10
          x-speakeasy-terraform-ignore: true
        total:
          type: number
          example: 100
          x-speakeasy-terraform-ignore: true
      required:
      - number
      - size
      - total
    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
  requestBodies:
    PutApiPackagePublicationRequest:
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiPackagePublication'
    PutApiPublicationRequest:
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiPublication'
  responses:
    ApiUnauthorized:
      description: ApiUnauthorized
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/UnauthorizedError'
    ApiPublicationBadRequest:
      description: Bad Request
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/BadRequestError'
    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
    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
    ApiNotFound:
      description: Not Found
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/NotFoundError'
    ApiForbidden:
      description: ApiForbidden
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/ForbiddenError'
    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
    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
  parameters:
    PortalApiPublicationSort:
      name: sort
      description: "Sorts a collection of API publications within a portal. Supported sort attributes are:\n\n\n  - api_id\n  - api_name\n  - created_at\n  - updated_at\n"
      required: false
      in: query
      schema:
        $ref: '#/components/schemas/SortQuery'
    ApiId:
      schema:
        type: string
        format: uuid
        example: 9f5061ce-78f6-4452-9108-ad7c02821fd5
      name: apiId
      in: path
      required: true
      description: The UUID API identifier
    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
    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'
    ApiPackageId:
      schema:
        type: string
        format: uuid
        example: 9f5061ce-78f6-4452-9108-ad7c02821fd5
      name: apiPackageId
      in: path
      required: true
      description: The UUID API Package identifier
    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
      x-speakeasy-terraform-ignore: true
    ApiPublicationFilters:
      name: filter
      description: Filters API Publications in the response.
      required: false
      in: query
      schema:
        $ref: '#/components/schemas/ApiPublicationFilterParameters'
      style: deepObject
    PageNumber:
      name: page[number]
      description: Determines which page of the entities to retrieve.
      required: false
      in: query
      allowEmptyValue: true
      schema:
        type: integer
        example: 1
      x-speakeasy-terraform-ignore: true
    PortalId:
      schema:
        type: string
        format: uuid
        example: f32d905a-ed33-46a3-a093-d8f536af9a8a
      name: portalId
      in: path
      required: true
      description: ID of the portal.
  securitySchemes:
    adminToken:
      in: header
      name: Kong-Admin-Token
      type: apiKey
externalDocs:
  description: Documentation for Kong Gateway and its APIs
  url: https://developer.konghq.com