diff --git a/api-specs/Konnect/control-planes-config/control-planes-config.yaml b/api-specs/Konnect/control-planes-config/control-planes-config.yaml index 59eb5c71df33..b2b29a29513a 100644 --- a/api-specs/Konnect/control-planes-config/control-planes-config.yaml +++ b/api-specs/Konnect/control-planes-config/control-planes-config.yaml @@ -16,8 +16,13 @@ info: version: 0.0.1 servers: - url: 'https://us.api.konghq.com/v2' + description: United-States Production region - url: 'https://eu.api.konghq.com/v2' + description: Europe Production region - url: 'https://au.api.konghq.com/v2' + description: Australia Production region + - url: 'https://me.api.konghq.com/v2' + description: Middle-East Production region paths: '/control-planes/{controlPlaneId}/expected-config-hash': get: @@ -263,6 +268,27 @@ paths: - ACLs parameters: - $ref: '#/components/parameters/controlPlaneId' + '/control-planes/{controlPlaneId}/core-entities/acls/{ACLId}': + get: + operationId: get-acl + summary: Fetch an ACL + description: Get an ACL using ID. + responses: + '200': + description: Successfully fetched ACL + content: + application/json: + schema: + $ref: '#/components/schemas/ACL' + '401': + $ref: '#/components/responses/HTTP401Error' + '404': + description: Resource does not exist + tags: + - ACLs + parameters: + - $ref: '#/components/parameters/ACLId' + - $ref: '#/components/parameters/controlPlaneId' '/control-planes/{controlPlaneId}/core-entities/basic-auths': get: operationId: list-basic-auth @@ -294,6 +320,27 @@ paths: - Basic-auth credentials parameters: - $ref: '#/components/parameters/controlPlaneId' + '/control-planes/{controlPlaneId}/core-entities/basic-auths/{BasicAuthId}': + get: + operationId: get-basic-auth + summary: Fetch a Basic-auth credential + description: Get a Basic-auth credential using ID. + responses: + '200': + description: Successfully fetched Basic-auth credential + content: + application/json: + schema: + $ref: '#/components/schemas/BasicAuth' + '401': + $ref: '#/components/responses/HTTP401Error' + '404': + description: Resource does not exist + tags: + - Basic-auth credentials + parameters: + - $ref: '#/components/parameters/BasicAuthId' + - $ref: '#/components/parameters/controlPlaneId' '/control-planes/{controlPlaneId}/core-entities/ca_certificates': get: operationId: list-ca_certificate @@ -730,6 +777,21 @@ paths: tags: - Consumer Groups '/control-planes/{controlPlaneId}/core-entities/consumer_groups/{ConsumerGroupId}/consumers': + delete: + operationId: remove-all-consumers-from-consumer-group + summary: Remove consumers from consumer group + description: |- + **Pre-release Endpoint** + This endpoint is currently in beta and is subject to change. + + Removes all consumers from a consumer groups. This operation does not delete the consumer group. + responses: + '204': + description: Consumers removed from group + '404': + description: Consumer group or consumer association does not exist + tags: + - Consumer Groups get: operationId: list-consumers-for-consumer-group summary: List all Consumers in a Consumer Group @@ -1024,6 +1086,19 @@ paths: tags: - Consumers '/control-planes/{controlPlaneId}/core-entities/consumers/{ConsumerId}/consumer_groups': + delete: + operationId: remove-consumer-from-all-consumer-groups + summary: Remove consumer from consumer group + description: Removes a consumer from all consumer groups. This operation does not delete the consumer group. + parameters: + - $ref: '#/components/parameters/ConsumerId' + responses: + '204': + description: Consumer removed from all groups + '404': + description: Consumer does not exist + tags: + - Consumer Groups get: operationId: list-consumer-groups-for-consumer summary: List all Consumer Groups a Consumer belongs to @@ -1886,6 +1961,27 @@ paths: - HMAC-auth credentials parameters: - $ref: '#/components/parameters/controlPlaneId' + '/control-planes/{controlPlaneId}/core-entities/hmac-auths/{HMACAuthId}': + get: + operationId: get-hmac-auth + summary: Fetch a HMAC-auth credential + description: Get a HMAC-auth credential using ID. + responses: + '200': + description: Successfully fetched HMAC-auth credential + content: + application/json: + schema: + $ref: '#/components/schemas/HMACAuth' + '401': + $ref: '#/components/responses/HTTP401Error' + '404': + description: Resource does not exist + tags: + - HMAC-auth credentials + parameters: + - $ref: '#/components/parameters/HMACAuthId' + - $ref: '#/components/parameters/controlPlaneId' '/control-planes/{controlPlaneId}/core-entities/jwts': get: operationId: list-jwt @@ -1917,6 +2013,27 @@ paths: - JWTs parameters: - $ref: '#/components/parameters/controlPlaneId' + '/control-planes/{controlPlaneId}/core-entities/jwts/{JWTId}': + get: + operationId: get-jwt + summary: Fetch a JWT + description: Get a JWT using ID. + responses: + '200': + description: Successfully fetched JWT + content: + application/json: + schema: + $ref: '#/components/schemas/JWT' + '401': + $ref: '#/components/responses/HTTP401Error' + '404': + description: Resource does not exist + tags: + - JWTs + parameters: + - $ref: '#/components/parameters/JWTId' + - $ref: '#/components/parameters/controlPlaneId' '/control-planes/{controlPlaneId}/core-entities/key-auths': get: operationId: list-key-auth @@ -1948,6 +2065,27 @@ paths: - API-keys parameters: - $ref: '#/components/parameters/controlPlaneId' + '/control-planes/{controlPlaneId}/core-entities/key-auths/{KeyAuthId}': + get: + operationId: get-key-auth + summary: Fetch an API-key + description: Get an API-key using ID. + responses: + '200': + description: Successfully fetched API-key + content: + application/json: + schema: + $ref: '#/components/schemas/KeyAuth' + '401': + $ref: '#/components/responses/HTTP401Error' + '404': + description: Resource does not exist + tags: + - API-keys + parameters: + - $ref: '#/components/parameters/KeyAuthId' + - $ref: '#/components/parameters/controlPlaneId' '/control-planes/{controlPlaneId}/core-entities/key-sets': get: operationId: list-key-set @@ -2305,6 +2443,27 @@ paths: - MTLS-auth credentials parameters: - $ref: '#/components/parameters/controlPlaneId' + '/control-planes/{controlPlaneId}/core-entities/mtls-auths/{MTLSAuthId}': + get: + operationId: get-mtls-auth + summary: Fetch a MTLS-auth credential + description: Get a MTLS-auth credential using ID. + responses: + '200': + description: Successfully fetched MTLS-auth credential + content: + application/json: + schema: + $ref: '#/components/schemas/MTLSAuth' + '401': + $ref: '#/components/responses/HTTP401Error' + '404': + description: Resource does not exist + tags: + - MTLS-auth credentials + parameters: + - $ref: '#/components/parameters/MTLSAuthId' + - $ref: '#/components/parameters/controlPlaneId' '/control-planes/{controlPlaneId}/core-entities/plugins': get: operationId: list-plugin @@ -5554,7 +5713,6 @@ components: description: The configuration properties for the Vault which can be found on the vaults' documentation page. type: object additionalProperties: true - nullable: true created_at: description: Unix epoch when the resource was created. type: integer @@ -5595,6 +5753,7 @@ components: required: - name - prefix + - config BaseError: description: standard error type: object diff --git a/api-specs/Konnect/v0/yaml/mesh-control-planes.yaml b/api-specs/Konnect/v0/yaml/mesh-control-planes.yaml index 334fd240e805..0d7eb726e092 100644 --- a/api-specs/Konnect/v0/yaml/mesh-control-planes.yaml +++ b/api-specs/Konnect/v0/yaml/mesh-control-planes.yaml @@ -8,11 +8,13 @@ info: url: 'https://konghq.com' servers: - url: 'https://us.api.konghq.com/v1' - description: US Public API + description: United-States Production region - url: 'https://eu.api.konghq.com/v1' - description: EU Public API + description: Europe Production region - url: 'https://au.api.konghq.com/v1' - description: AU Public API + description: Australia Production region + - url: 'https://me.api.konghq.com/v1' + description: Middle-East Production region paths: /mesh/control-planes: get: diff --git a/api-specs/Konnect/v1/yaml/ksearch.yaml b/api-specs/Konnect/v1/yaml/ksearch.yaml index 9582236710aa..cd030d0b1654 100644 --- a/api-specs/Konnect/v1/yaml/ksearch.yaml +++ b/api-specs/Konnect/v1/yaml/ksearch.yaml @@ -7,14 +7,14 @@ info: name: Kong url: 'https://konghq.com' servers: - - url: 'https://global.api.konghq.com/v1' - description: Global Base URL - url: 'https://us.api.konghq.com/v1' - description: US Region Base URL + description: United-States Production region - url: 'https://eu.api.konghq.com/v1' - description: EU Region Base URL + description: Europe Production region - url: 'https://au.api.konghq.com/v1' - description: AU Region Base URL + description: Australia Production region + - url: 'https://me.api.konghq.com/v1' + description: Middle-East Production region paths: /search: get: diff --git a/api-specs/Konnect/v2/yaml/analytics-reports.yaml b/api-specs/Konnect/v2/yaml/analytics-reports.yaml index c4ccbdb5e15b..36a2661692cc 100644 --- a/api-specs/Konnect/v2/yaml/analytics-reports.yaml +++ b/api-specs/Konnect/v2/yaml/analytics-reports.yaml @@ -8,11 +8,13 @@ info: url: 'https://cloud.konghq.com' servers: - url: 'https://us.api.konghq.com/v2' - description: US Region Konnect Platform Base URL + description: United-States Production region - url: 'https://eu.api.konghq.com/v2' - description: EU Region Konnect Platform Base URL + description: Europe Production region - url: 'https://au.api.konghq.com/v2' - description: AU Region Konnect Platform Base URL + description: Australia Production region + - url: 'https://me.api.konghq.com/v2' + description: Middle-East Production region paths: /reports: get: diff --git a/api-specs/Konnect/v2/yaml/analytics-requests.yaml b/api-specs/Konnect/v2/yaml/analytics-requests.yaml index 58359a95e059..2825fc94d6e6 100644 --- a/api-specs/Konnect/v2/yaml/analytics-requests.yaml +++ b/api-specs/Konnect/v2/yaml/analytics-requests.yaml @@ -8,11 +8,13 @@ info: url: 'https://cloud.konghq.com' servers: - url: 'https://us.api.konghq.com/v2' - description: US Region Konnect Platform Base URL + description: United-States Production region - url: 'https://eu.api.konghq.com/v2' - description: EU Region Konnect Platform Base URL + description: Europe Production region - url: 'https://au.api.konghq.com/v2' - description: AU Region Konnect Platform Base URL + description: Australia Production region + - url: 'https://me.api.konghq.com/v2' + description: Middle-East Production region paths: /api-requests: post: diff --git a/api-specs/Konnect/v2/yaml/api-products.yaml b/api-specs/Konnect/v2/yaml/api-products.yaml index c6cd19c1f423..af836cf1f41b 100644 --- a/api-specs/Konnect/v2/yaml/api-products.yaml +++ b/api-specs/Konnect/v2/yaml/api-products.yaml @@ -8,11 +8,13 @@ info: url: 'https://cloud.konghq.com' servers: - url: 'https://us.api.konghq.com/v2' - description: US Region Base URL + description: United-States Production region - url: 'https://eu.api.konghq.com/v2' - description: EU Region Base URL + description: Europe Production region - url: 'https://au.api.konghq.com/v2' - description: AU Region Base URL + description: Australia Production region + - url: 'https://me.api.konghq.com/v2' + description: Middle-East Production region paths: /api-products: post: @@ -53,6 +55,7 @@ paths: - $ref: '#/components/parameters/APIProductFilters' - $ref: '#/components/parameters/APIProductSort' - $ref: '#/components/parameters/LabelsFilter' + - $ref: '#/components/parameters/PublicLabelsFilter' responses: '200': $ref: '#/components/responses/ListAPIProductResponse' @@ -644,6 +647,14 @@ components: schema: type: integer example: 10 + PublicLabelsFilter: + name: public_labels + description: Filters requested resource by associated public labels. + required: false + in: query + schema: + type: string + example: 'key:value,keyExists' schemas: APIProductFilterParameters: type: object @@ -807,6 +818,8 @@ components: $ref: '#/components/schemas/UpdatedAt' labels: $ref: '#/components/schemas/Labels' + public_labels: + $ref: '#/components/schemas/PublicLabels' additionalProperties: false required: - id @@ -817,6 +830,7 @@ components: - created_at - updated_at - labels + - public_labels - version_count title: API Product APIProductDocumentSummary: @@ -1073,6 +1087,8 @@ components: nullable: true labels: $ref: '#/components/schemas/Labels' + public_labels: + $ref: '#/components/schemas/PublicLabels' portal_ids: description: The list of portal identifiers which this API product should be published to type: array @@ -1104,6 +1120,8 @@ components: nullable: true labels: $ref: '#/components/schemas/LabelsUpdate' + public_labels: + $ref: '#/components/schemas/PublicLabelsUpdate' portal_ids: description: The list of portal identifiers which this API product should be published to type: array @@ -1492,6 +1510,23 @@ components: maxLength: 63 maxProperties: 50 title: Labels + PublicLabels: + description: | + Public labels store information about an entity that can be used for filtering a list of objects. + + Public labels are intended to store **PUBLIC** metadata. + + Keys must be of length 1-63 characters, and cannot start with "kong", "konnect", "mesh", "kic", or "_". + 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 @@ -1816,6 +1851,25 @@ components: maxProperties: 50 nullable: true writeOnly: true + PublicLabelsUpdate: + description: | + Public labels store information about an entity that can be used for filtering a list of objects. + + Public labels are intended to store **PUBLIC** metadata. + + Keys must be of length 1-63 characters, and cannot start with "kong", "konnect", "mesh", "kic", or "_". + 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 + nullable: true + maxProperties: 50 + title: PublicLabelsUpdate + writeOnly: true PublishStatus: type: string enum: @@ -2221,6 +2275,8 @@ components: version_count: 10 labels: env: test + public_labels: + label: value APIProductVersionExample: value: id: 9f5061ce-78f6-4452-9108-ad7c02821fd5 @@ -2745,6 +2801,8 @@ components: version_count: 10 labels: env: test + public_labels: + label: value meta: page: number: 1 diff --git a/api-specs/Konnect/v2/yaml/application-auth-strategies.yaml b/api-specs/Konnect/v2/yaml/application-auth-strategies.yaml index 1140738e6be8..723987b1c114 100644 --- a/api-specs/Konnect/v2/yaml/application-auth-strategies.yaml +++ b/api-specs/Konnect/v2/yaml/application-auth-strategies.yaml @@ -8,11 +8,13 @@ info: url: 'https://cloud.konghq.com' servers: - url: 'https://us.api.konghq.com/v2' - description: US Region Base URL + description: United-States Production region - url: 'https://eu.api.konghq.com/v2' - description: EU Region Base URL + description: Europe Production region - url: 'https://au.api.konghq.com/v2' - description: AU Region Base URL + description: Australia Production region + - url: 'https://me.api.konghq.com/v2' + description: Middle-East Production region paths: /dcr-providers: post: diff --git a/api-specs/Konnect/v2/yaml/audit-logs.yaml b/api-specs/Konnect/v2/yaml/audit-logs.yaml index f1b345782012..118ebfd0c9ef 100644 --- a/api-specs/Konnect/v2/yaml/audit-logs.yaml +++ b/api-specs/Konnect/v2/yaml/audit-logs.yaml @@ -8,11 +8,13 @@ info: url: 'https://konghq.com' servers: - url: 'https://us.api.konghq.com/v2' - description: US URL + description: United-States Production region - url: 'https://eu.api.konghq.com/v2' - description: EU URL + description: Europe Production region - url: 'https://au.api.konghq.com/v2' - description: AU URL + description: Australia Production region + - url: 'https://me.api.konghq.com/v2' + description: Middle-East Production region paths: /audit-log-replay-job: put: diff --git a/api-specs/Konnect/v2/yaml/control-planes.yaml b/api-specs/Konnect/v2/yaml/control-planes.yaml index 1401e9352e17..628ebbf62d3b 100644 --- a/api-specs/Konnect/v2/yaml/control-planes.yaml +++ b/api-specs/Konnect/v2/yaml/control-planes.yaml @@ -8,11 +8,13 @@ info: url: 'https://cloud.konghq.com' servers: - url: 'https://us.api.konghq.com/v2' - description: US Region Base URL + description: United-States Production region - url: 'https://eu.api.konghq.com/v2' - description: EU Region Base URL + description: Europe Production region - url: 'https://au.api.konghq.com/v2' - description: AU Region Base URL + description: Australia Production region + - url: 'https://me.api.konghq.com/v2' + description: Middle-East Production region paths: /control-planes: get: @@ -1262,38 +1264,40 @@ components: updated_at: '2022-11-04T20:10:06.927Z' GroupConflictStatusExample: value: - id: 7f9fd312-a987-4628-b4c5-bb4f4fddd5f7 - conflicts: - - cluster_id: 57fdf779-7935-476f-ab2b-7fa1323b70e6 - description: 'conflicting entity found: ID=df43b088-cace-4119-9e2a-d83e5fbb0c48, Name=svc1' - resource: - id: df43b088-cace-4119-9e2a-d83e5fbb0c48 - type: service - - cluster_id: 38ceea96-fe39-11ed-be56-0242ac120002 - description: 'conflicting entity found: ID=15f3ab7d-7202-498a-95b4-334f783dbcdd, Name=svc1' - resource: - id: 15f3ab7d-7202-498a-95b4-334f783dbcdd - type: service - state: CONFLICT - created_at: '2022-11-04T20:10:06.927Z' - updated_at: '2022-11-04T20:10:06.927Z' + item: + id: 7f9fd312-a987-4628-b4c5-bb4f4fddd5f7 + conflicts: + - cluster_id: 57fdf779-7935-476f-ab2b-7fa1323b70e6 + description: 'conflicting entity found: ID=df43b088-cace-4119-9e2a-d83e5fbb0c48, Name=svc1' + resource: + id: df43b088-cace-4119-9e2a-d83e5fbb0c48 + type: service + - cluster_id: 38ceea96-fe39-11ed-be56-0242ac120002 + description: 'conflicting entity found: ID=15f3ab7d-7202-498a-95b4-334f783dbcdd, Name=svc1' + resource: + id: 15f3ab7d-7202-498a-95b4-334f783dbcdd + type: service + state: CONFLICT + created_at: '2022-11-04T20:10:06.927Z' + updated_at: '2022-11-04T20:10:06.927Z' GroupNoConflictStatusExample: value: - id: 7f9fd312-a987-4628-b4c5-bb4f4fddd5f7 - conflicts: - - cluster_id: 57fdf779-7935-476f-ab2b-7fa1323b70e6 - description: 'conflicting entity found: ID=df43b088-cace-4119-9e2a-d83e5fbb0c48, Name=svc1' - resource: - id: df43b088-cace-4119-9e2a-d83e5fbb0c48 - type: service - - cluster_id: 38ceea96-fe39-11ed-be56-0242ac120002 - description: 'conflicting entity found: ID=15f3ab7d-7202-498a-95b4-334f783dbcdd, Name=svc1' - resource: - id: 15f3ab7d-7202-498a-95b4-334f783dbcdd - type: service - state: CONFLICT - created_at: '2022-11-04T20:10:06.927Z' - updated_at: '2022-11-04T20:10:06.927Z' + item: + id: 7f9fd312-a987-4628-b4c5-bb4f4fddd5f7 + conflicts: + - cluster_id: 57fdf779-7935-476f-ab2b-7fa1323b70e6 + description: 'conflicting entity found: ID=df43b088-cace-4119-9e2a-d83e5fbb0c48, Name=svc1' + resource: + id: df43b088-cace-4119-9e2a-d83e5fbb0c48 + type: service + - cluster_id: 38ceea96-fe39-11ed-be56-0242ac120002 + description: 'conflicting entity found: ID=15f3ab7d-7202-498a-95b4-334f783dbcdd, Name=svc1' + resource: + id: 15f3ab7d-7202-498a-95b4-334f783dbcdd + type: service + state: CONFLICT + created_at: '2022-11-04T20:10:06.927Z' + updated_at: '2022-11-04T20:10:06.927Z' ListGroupMembershipsExample: value: meta: @@ -1587,7 +1591,10 @@ components: content: application/json: schema: - $ref: '#/components/schemas/GroupStatus' + type: object + properties: + item: + $ref: '#/components/schemas/GroupStatus' examples: Group Conflict Status Example: $ref: '#/components/examples/GroupConflictStatusExample' diff --git a/api-specs/Konnect/v2/yaml/portal-management.yaml b/api-specs/Konnect/v2/yaml/portal-management.yaml index 6caf018bdcef..e81063b135f5 100644 --- a/api-specs/Konnect/v2/yaml/portal-management.yaml +++ b/api-specs/Konnect/v2/yaml/portal-management.yaml @@ -8,11 +8,13 @@ info: url: 'https://konghq.com' servers: - url: 'https://us.api.konghq.com/v2' - description: US Region Base URL + description: United-States Production region - url: 'https://eu.api.konghq.com/v2' - description: EU Region Base URL + description: Europe Production region - url: 'https://au.api.konghq.com/v2' - description: AU Region Base URL + description: Australia Production region + - url: 'https://me.api.konghq.com/v2' + description: Middle-East Production region paths: /portals: get: diff --git a/api-specs/portal.yaml b/api-specs/portal.yaml index ce733fbfb519..15a115da6c05 100644 --- a/api-specs/portal.yaml +++ b/api-specs/portal.yaml @@ -2609,9 +2609,12 @@ components: 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 @@ -2892,6 +2895,23 @@ components: - title - content title: ProductDocumentRaw + PublicLabels: + description: | + Public labels store information about an entity that can be used for filtering a list of objects. + + Public labels are intended to store **PUBLIC** metadata. + + Keys must be of length 1-63 characters, and cannot start with "kong", "konnect", "mesh", "kic", or "_". + 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 NullableUUID: description: Contains a unique identifier for a resource. type: string @@ -3557,6 +3577,8 @@ components: required: - name - id + public_labels: + $ref: '#/components/schemas/PublicLabels' additionalProperties: false required: - id @@ -3566,6 +3588,7 @@ components: - document_count - version_count - latest_version + - public_labels title: ProductCatalogIndexSource SearchIndicesParameters: type: string @@ -3893,6 +3916,8 @@ components: description: Great products are built with great care document_count: 5 version_count: 5 + public_labels: + env: test latest_version: name: v5 id: 455b0beb-c3f7-4f8f-95f7-cd8ff0ee478e