From 6ba7f7ef4c4121278c2e99dc4f6339fa15b28126 Mon Sep 17 00:00:00 2001 From: lena-larionova Date: Wed, 22 Jan 2025 10:30:36 -0800 Subject: [PATCH] add schema for consumer groups --- api-specs/Gateway-EE/3.4/kong-ee-3.4.yaml | 26 +++++++++++++++++++++++ api-specs/Gateway-EE/3.5/kong-ee-3.5.yaml | 26 +++++++++++++++++++++++ api-specs/Gateway-EE/3.6/kong-ee-3.6.yaml | 26 +++++++++++++++++++++++ api-specs/Gateway-EE/3.7/kong-ee-3.7.yaml | 26 +++++++++++++++++++++++ api-specs/Gateway-EE/3.8/kong-ee.yaml | 26 +++++++++++++++++++++++ api-specs/Gateway-EE/3.9/kong-ee.yaml | 26 +++++++++++++++++++++++ api-specs/Gateway-EE/latest/kong-ee.yaml | 26 +++++++++++++++++++++++ 7 files changed, 182 insertions(+) diff --git a/api-specs/Gateway-EE/3.4/kong-ee-3.4.yaml b/api-specs/Gateway-EE/3.4/kong-ee-3.4.yaml index 6f4fc308cbe6..d1ec03132abc 100644 --- a/api-specs/Gateway-EE/3.4/kong-ee-3.4.yaml +++ b/api-specs/Gateway-EE/3.4/kong-ee-3.4.yaml @@ -513,6 +513,32 @@ components: tags: - silver-tier username: bob-the-builder + ConsumerGroup: + description: Consumer groups enable the organization and categorization of consumers (users or applications) within an API ecosystem. By grouping consumers together, you eliminate the need to manage them individually, providing a scalable, efficient approach to managing configurations. + type: object + properties: + created_at: + description: Unix epoch when the resource was created. + type: integer + id: + type: string + format: uuid + description: Unique identifier for the Consumer Group. + nullable: true + name: + type: string + description: The name of the Consumer Group. + tags: + description: An optional set of strings associated with the Consumer Group for grouping and filtering. + items: + type: string + type: array + updated_at: + description: Unix epoch when the resource was last updated. + type: integer + additionalProperties: false + required: + - name Key: description: A Key object holds a representation of asymmetric keys in various formats. When Kong or a Kong plugin requires a specific public or private key to perform certain operations, it can use this entity. example: diff --git a/api-specs/Gateway-EE/3.5/kong-ee-3.5.yaml b/api-specs/Gateway-EE/3.5/kong-ee-3.5.yaml index 2c67dc83d9be..ece80699dd03 100644 --- a/api-specs/Gateway-EE/3.5/kong-ee-3.5.yaml +++ b/api-specs/Gateway-EE/3.5/kong-ee-3.5.yaml @@ -343,6 +343,32 @@ components: tags: - silver-tier username: bob-the-builder + ConsumerGroup: + description: Consumer groups enable the organization and categorization of consumers (users or applications) within an API ecosystem. By grouping consumers together, you eliminate the need to manage them individually, providing a scalable, efficient approach to managing configurations. + type: object + properties: + created_at: + description: Unix epoch when the resource was created. + type: integer + id: + type: string + format: uuid + description: Unique identifier for the Consumer Group. + nullable: true + name: + type: string + description: The name of the Consumer Group. + tags: + description: An optional set of strings associated with the Consumer Group for grouping and filtering. + items: + type: string + type: array + updated_at: + description: Unix epoch when the resource was last updated. + type: integer + additionalProperties: false + required: + - name Key: description: A Key object holds a representation of asymmetric keys in various formats. When Kong or a Kong plugin requires a specific public or private key to perform certain operations, it can use this entity. example: diff --git a/api-specs/Gateway-EE/3.6/kong-ee-3.6.yaml b/api-specs/Gateway-EE/3.6/kong-ee-3.6.yaml index d71e9fb601db..a954875767cb 100644 --- a/api-specs/Gateway-EE/3.6/kong-ee-3.6.yaml +++ b/api-specs/Gateway-EE/3.6/kong-ee-3.6.yaml @@ -424,6 +424,32 @@ components: tags: - silver-tier username: bob-the-builder + ConsumerGroup: + description: Consumer groups enable the organization and categorization of consumers (users or applications) within an API ecosystem. By grouping consumers together, you eliminate the need to manage them individually, providing a scalable, efficient approach to managing configurations. + type: object + properties: + created_at: + description: Unix epoch when the resource was created. + type: integer + id: + type: string + format: uuid + description: Unique identifier for the Consumer Group. + nullable: true + name: + type: string + description: The name of the Consumer Group. + tags: + description: An optional set of strings associated with the Consumer Group for grouping and filtering. + items: + type: string + type: array + updated_at: + description: Unix epoch when the resource was last updated. + type: integer + additionalProperties: false + required: + - name Key: description: A Key object holds a representation of asymmetric keys in various formats. When Kong or a Kong plugin requires a specific public or private key to perform certain operations, it can use this entity. example: diff --git a/api-specs/Gateway-EE/3.7/kong-ee-3.7.yaml b/api-specs/Gateway-EE/3.7/kong-ee-3.7.yaml index 4bf261b2d247..785a7bab0109 100644 --- a/api-specs/Gateway-EE/3.7/kong-ee-3.7.yaml +++ b/api-specs/Gateway-EE/3.7/kong-ee-3.7.yaml @@ -442,6 +442,32 @@ components: tags: - silver-tier username: bob-the-builder + ConsumerGroup: + description: Consumer groups enable the organization and categorization of consumers (users or applications) within an API ecosystem. By grouping consumers together, you eliminate the need to manage them individually, providing a scalable, efficient approach to managing configurations. + type: object + properties: + created_at: + description: Unix epoch when the resource was created. + type: integer + id: + type: string + format: uuid + description: Unique identifier for the Consumer Group. + nullable: true + name: + type: string + description: The name of the Consumer Group. + tags: + description: An optional set of strings associated with the Consumer Group for grouping and filtering. + items: + type: string + type: array + updated_at: + description: Unix epoch when the resource was last updated. + type: integer + additionalProperties: false + required: + - name Key: description: A Key object holds a representation of asymmetric keys in various formats. When Kong or a Kong plugin requires a specific public or private key to perform certain operations, it can use this entity. example: diff --git a/api-specs/Gateway-EE/3.8/kong-ee.yaml b/api-specs/Gateway-EE/3.8/kong-ee.yaml index 6412160357d8..b25efa247f6b 100644 --- a/api-specs/Gateway-EE/3.8/kong-ee.yaml +++ b/api-specs/Gateway-EE/3.8/kong-ee.yaml @@ -451,6 +451,32 @@ components: tags: - silver-tier username: bob-the-builder + ConsumerGroup: + description: Consumer groups enable the organization and categorization of consumers (users or applications) within an API ecosystem. By grouping consumers together, you eliminate the need to manage them individually, providing a scalable, efficient approach to managing configurations. + type: object + properties: + created_at: + description: Unix epoch when the resource was created. + type: integer + id: + type: string + format: uuid + description: Unique identifier for the Consumer Group. + nullable: true + name: + type: string + description: The name of the Consumer Group. + tags: + description: An optional set of strings associated with the Consumer Group for grouping and filtering. + items: + type: string + type: array + updated_at: + description: Unix epoch when the resource was last updated. + type: integer + additionalProperties: false + required: + - name Key: description: A Key object holds a representation of asymmetric keys in various formats. When Kong or a Kong plugin requires a specific public or private key to perform certain operations, it can use this entity. example: diff --git a/api-specs/Gateway-EE/3.9/kong-ee.yaml b/api-specs/Gateway-EE/3.9/kong-ee.yaml index b27038d3dce8..0d222bba3f81 100644 --- a/api-specs/Gateway-EE/3.9/kong-ee.yaml +++ b/api-specs/Gateway-EE/3.9/kong-ee.yaml @@ -458,6 +458,32 @@ components: tags: - silver-tier username: bob-the-builder + ConsumerGroup: + description: Consumer groups enable the organization and categorization of consumers (users or applications) within an API ecosystem. By grouping consumers together, you eliminate the need to manage them individually, providing a scalable, efficient approach to managing configurations. + type: object + properties: + created_at: + description: Unix epoch when the resource was created. + type: integer + id: + type: string + format: uuid + description: Unique identifier for the Consumer Group. + nullable: true + name: + type: string + description: The name of the Consumer Group. + tags: + description: An optional set of strings associated with the Consumer Group for grouping and filtering. + items: + type: string + type: array + updated_at: + description: Unix epoch when the resource was last updated. + type: integer + additionalProperties: false + required: + - name Event-Hooks: type: object description: Event Hooks schema diff --git a/api-specs/Gateway-EE/latest/kong-ee.yaml b/api-specs/Gateway-EE/latest/kong-ee.yaml index d86d4f5192e5..7dbad26ebd5a 100644 --- a/api-specs/Gateway-EE/latest/kong-ee.yaml +++ b/api-specs/Gateway-EE/latest/kong-ee.yaml @@ -451,6 +451,32 @@ components: tags: - silver-tier username: bob-the-builder + ConsumerGroup: + description: Consumer groups enable the organization and categorization of consumers (users or applications) within an API ecosystem. By grouping consumers together, you eliminate the need to manage them individually, providing a scalable, efficient approach to managing configurations. + type: object + properties: + created_at: + description: Unix epoch when the resource was created. + type: integer + id: + type: string + format: uuid + description: Unique identifier for the Consumer Group. + nullable: true + name: + type: string + description: The name of the Consumer Group. + tags: + description: An optional set of strings associated with the Consumer Group for grouping and filtering. + items: + type: string + type: array + updated_at: + description: Unix epoch when the resource was last updated. + type: integer + additionalProperties: false + required: + - name Key: description: A Key object holds a representation of asymmetric keys in various formats. When Kong or a Kong plugin requires a specific public or private key to perform certain operations, it can use this entity. example: