From bb22a36c4e64ca096b3a6d6e73707d49f0215e79 Mon Sep 17 00:00:00 2001 From: kong-apiops <122612077+kong-apiops@users.noreply.github.com> Date: Fri, 12 Jul 2024 21:09:52 +0100 Subject: [PATCH] feat(sdk): automated oas update (#7636) Updated in Konnect too --- api-specs/Konnect/v1/yaml/ksearch.yaml | 4 - api-specs/Konnect/v2/yaml/api-products.yaml | 1 + .../Konnect/v2/yaml/portal-management.yaml | 128 +++++++----------- api-specs/Konnect/v3/yaml/identity.yaml | 98 -------------- 4 files changed, 50 insertions(+), 181 deletions(-) diff --git a/api-specs/Konnect/v1/yaml/ksearch.yaml b/api-specs/Konnect/v1/yaml/ksearch.yaml index 42e2641cc998..41077925c81b 100644 --- a/api-specs/Konnect/v1/yaml/ksearch.yaml +++ b/api-specs/Konnect/v1/yaml/ksearch.yaml @@ -44,8 +44,6 @@ paths: $ref: '#/components/responses/SearchResponse' '400': $ref: '#/components/responses/SearchBadRequest' - servers: - - url: https://global.api.konghq.com/ /search/types: get: operationId: get-search-types @@ -56,8 +54,6 @@ paths: responses: '200': $ref: '#/components/responses/SearchTypesResponse' - servers: - - url: https://global.api.konghq.com/ components: responses: SearchResponse: diff --git a/api-specs/Konnect/v2/yaml/api-products.yaml b/api-specs/Konnect/v2/yaml/api-products.yaml index 7f4d1d6bfb2f..37c4e15096ea 100644 --- a/api-specs/Konnect/v2/yaml/api-products.yaml +++ b/api-specs/Konnect/v2/yaml/api-products.yaml @@ -1440,6 +1440,7 @@ components: type: string description: The name of the API product version specification example: oas.yaml + pattern: .+(\.yaml|\.yml|\.json) content: type: string description: The contents of the API product version specification diff --git a/api-specs/Konnect/v2/yaml/portal-management.yaml b/api-specs/Konnect/v2/yaml/portal-management.yaml index e959533df8d3..c001407a5fed 100644 --- a/api-specs/Konnect/v2/yaml/portal-management.yaml +++ b/api-specs/Konnect/v2/yaml/portal-management.yaml @@ -1,7 +1,7 @@ openapi: 3.0.3 info: title: Portal Management - version: 2.1.0 + version: 2.2.0 description: The management API for Portals contact: name: Kong @@ -151,7 +151,13 @@ paths: $ref: '#/components/responses/Forbidden' /portals/{portalId}: parameters: - - $ref: '#/components/parameters/parameters-PortalId' + - name: portalId + in: path + schema: + type: string + format: uuid + required: true + description: ID of the portal. get: summary: Get Portal description: >- @@ -5690,7 +5696,7 @@ components: default_application_auth_strategy_id: $ref: '#/components/schemas/DefaultApplicationAuthStratID' labels: - $ref: '#/components/schemas/PortalsLabels' + $ref: '#/components/schemas/Labels' application_count: type: number description: Number of applications created in the portal. @@ -5792,7 +5798,7 @@ components: default_application_auth_strategy_id: $ref: '#/components/schemas/DefaultApplicationAuthStratID' labels: - $ref: '#/components/schemas/PortalsLabelsNullable' + $ref: '#/components/schemas/Labels' example: name: DevPortal is_public: false @@ -5878,7 +5884,7 @@ components: default_application_auth_strategy_id: $ref: '#/components/schemas/DefaultApplicationAuthStratID' labels: - $ref: '#/components/schemas/PortalsLabelsNullable' + $ref: '#/components/schemas/LabelsUpdate' example: name: Aperture is_public: false @@ -6734,42 +6740,6 @@ components: - dark_mode - custom example: mint_rocket - PortalsLabels: - title: Labels - type: object - description: > - description: A maximum of 50 user-defined labels are allowed on this - resource. - - Keys must not start with kong, konnect, insomnia, mesh, kic or _, which - are reserved for Kong. - - Keys are case-sensitive. - additionalProperties: - type: string - pattern: ^[a-z0-9A-Z]{1}([a-z0-9A-Z\-._]*[a-z0-9A-Z]+)?$ - minLength: 1 - maxLength: 63 - default: {} - PortalsLabelsNullable: - nullable: true - title: Labels - type: object - description: > - description: A maximum of 50 user-defined labels are allowed on this - resource. - - Keys must not start with kong, konnect, insomnia, mesh, kic or _, which - are reserved for Kong. - - Keys are case-sensitive. - additionalProperties: - type: string - nullable: true - pattern: ^[a-z0-9A-Z]{1}([a-z0-9A-Z\-._]*[a-z0-9A-Z]+)?$ - minLength: 1 - maxLength: 63 - default: {} StringFieldEqualsFilter: title: StringFieldEqualsFilter description: Filters on the given string field value by exact match. @@ -6931,6 +6901,24 @@ components: example: '2022-11-04T20:10:06.927Z' description: An ISO-8601 timestamp representation of entity update date. readOnly: true + Labels: + title: Labels + type: object + example: + env: test + maxProperties: 50 + description: > + Labels store metadata of an entity that can be used for filtering an + entity list or for searching across entity types. + + + Keys must be of length 1-63 characters, and cannot start with "kong", + "konnect", "mesh", "kic", or "_". + additionalProperties: + type: string + pattern: ^[a-z0-9A-Z]{1}([a-z0-9A-Z-._]*[a-z0-9A-Z]+)?$ + minLength: 1 + maxLength: 63 BaseError: type: object title: Error @@ -7195,6 +7183,26 @@ components: example: kong:trace:1234567890 detail: example: Not found + LabelsUpdate: + type: object + nullable: true + description: > + Labels store metadata of an entity that can be used for filtering an + entity list or for searching across entity types. + + + Keys must be of length 1-63 characters, and cannot start with "kong", + "konnect", "mesh", "kic", or "_". + example: + env: test + maxProperties: 50 + additionalProperties: + type: string + pattern: ^[a-z0-9A-Z]{1}([a-z0-9A-Z-._]*[a-z0-9A-Z]+)?$ + minLength: 1 + maxLength: 63 + nullable: true + writeOnly: true ConflictError: allOf: - $ref: '#/components/schemas/BaseError' @@ -7210,24 +7218,6 @@ components: example: kong:trace:1234567890 detail: example: Conflict - Labels: - title: Labels - type: object - example: - env: test - maxProperties: 50 - description: > - Labels store metadata of an entity that can be used for filtering an - entity list or for searching across entity types. - - - Keys must be of length 1-63 characters, and cannot start with "kong", - "konnect", "mesh", "kic", or "_". - additionalProperties: - type: string - pattern: ^[a-z0-9A-Z]{1}([a-z0-9A-Z-._]*[a-z0-9A-Z]+)?$ - minLength: 1 - maxLength: 63 schemas-UUID: type: string format: uuid @@ -7375,26 +7365,6 @@ components: - self_managed_client_credentials auth_methods: $ref: '#/components/schemas/AuthMethods' - LabelsUpdate: - type: object - nullable: true - description: > - Labels store metadata of an entity that can be used for filtering an - entity list or for searching across entity types. - - - Keys must be of length 1-63 characters, and cannot start with "kong", - "konnect", "mesh", "kic", or "_". - example: - env: test - maxProperties: 50 - additionalProperties: - type: string - pattern: ^[a-z0-9A-Z]{1}([a-z0-9A-Z-._]*[a-z0-9A-Z]+)?$ - minLength: 1 - maxLength: 63 - nullable: true - writeOnly: true ImageDataUri: title: ImageDataUri type: string diff --git a/api-specs/Konnect/v3/yaml/identity.yaml b/api-specs/Konnect/v3/yaml/identity.yaml index 9f7d753a24af..fbd0aa539a24 100644 --- a/api-specs/Konnect/v3/yaml/identity.yaml +++ b/api-specs/Konnect/v3/yaml/identity.yaml @@ -43,8 +43,6 @@ paths: $ref: '#/components/responses/IdentityUnauthenticated' '404': $ref: '#/components/responses/IdentityNotFound' - servers: - - url: https://global.api.konghq.com/ patch: summary: Update Impersonation Settings description: Updates Impersonation Settings. @@ -64,8 +62,6 @@ paths: $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/IdentityNotFound' - servers: - - url: https://global.api.konghq.com/ /authentication-settings: get: summary: Get Auth Settings @@ -80,8 +76,6 @@ paths: $ref: '#/components/responses/AuthenticationSettings' '401': $ref: '#/components/responses/IdentityUnauthenticated' - servers: - - url: https://global.api.konghq.com/ patch: summary: Update Auth Settings description: Updates authentication configuration. @@ -99,8 +93,6 @@ paths: $ref: '#/components/responses/IdentityUnauthenticated' '403': $ref: '#/components/responses/Unauthorized' - servers: - - url: https://global.api.konghq.com/ /invites: post: summary: Invite User @@ -123,8 +115,6 @@ paths: $ref: '#/components/responses/RateLimited' tags: - Invites - servers: - - url: https://global.api.konghq.com/ /identity-provider: get: summary: Fetch IdP Configuration @@ -143,8 +133,6 @@ paths: tags: - Auth Settings description: Fetch the IdP configuration. - servers: - - url: https://global.api.konghq.com/ parameters: [] patch: summary: Update IdP Configuration @@ -163,8 +151,6 @@ paths: $ref: '#/components/requestBodies/UpdateIdPConfiguration' tags: - Auth Settings - servers: - - url: https://global.api.konghq.com/ /identity-provider/team-mappings: put: summary: Update Team Mappings @@ -185,8 +171,6 @@ paths: description: Updates the IdP group to Konnect team mapping. requestBody: $ref: '#/components/requestBodies/UpdateTeamMappings' - servers: - - url: https://global.api.konghq.com/ get: summary: Fetch Team Mapping operationId: get-idp-team-mappings @@ -207,8 +191,6 @@ paths: tags: - Auth Settings description: Fetch the IdP group to Konnect team mapping. - servers: - - url: https://global.api.konghq.com/ /identity-provider/team-group-mappings: get: summary: Fetch Team Group Mappings @@ -232,8 +214,6 @@ paths: Groups. Returns a 400 error if an Identity Provider has not yet been configured. - servers: - - url: https://global.api.konghq.com/ patch: summary: Patch Mappings by Team ID operationId: patch-team-group-mappings @@ -265,8 +245,6 @@ paths: the request body is not found or is not a UUID. requestBody: $ref: '#/components/requestBodies/PatchTeamGroupMappings' - servers: - - url: https://global.api.konghq.com/ /roles: get: summary: Get Predefined Roles @@ -281,8 +259,6 @@ paths: $ref: '#/components/responses/IdentityUnauthenticated' tags: - Roles - servers: - - url: https://global.api.konghq.com/ /teams: get: summary: List Teams @@ -312,8 +288,6 @@ paths: style: deepObject tags: - Teams - servers: - - url: https://global.api.konghq.com/ parameters: [] post: summary: Create Team @@ -330,8 +304,6 @@ paths: requestBody: $ref: '#/components/requestBodies/CreateTeam' description: 'Creates a team in the Konnect Organization. ' - servers: - - url: https://global.api.konghq.com/ /teams/{teamId}/users: parameters: - schema: @@ -376,8 +348,6 @@ paths: style: deepObject tags: - Team Membership - servers: - - url: https://global.api.konghq.com/ post: summary: Add User operationId: add-user-to-team @@ -393,8 +363,6 @@ paths: $ref: '#/components/requestBodies/AddUserToTeam' tags: - Team Membership - servers: - - url: https://global.api.konghq.com/ /teams/{teamId}: parameters: - schema: @@ -418,8 +386,6 @@ paths: description: Returns information about a team from a given team ID. tags: - Teams - servers: - - url: https://global.api.konghq.com/ patch: summary: Update Team operationId: update-team @@ -435,8 +401,6 @@ paths: $ref: '#/components/requestBodies/UpdateTeam' tags: - Teams - servers: - - url: https://global.api.konghq.com/ delete: summary: Delete Team operationId: delete-team @@ -450,8 +414,6 @@ paths: description: Deletes an individual team. Returns 404 if the team is not found. tags: - Teams - servers: - - url: https://global.api.konghq.com/ /teams/{teamId}/users/{userId}: parameters: - schema: @@ -487,8 +449,6 @@ paths: the user or team were not found. tags: - Team Membership - servers: - - url: https://global.api.konghq.com/ /teams/{teamId}/assigned-roles: parameters: - schema: @@ -531,8 +491,6 @@ paths: description: Filter roles returned in the response. required: false style: deepObject - servers: - - url: https://global.api.konghq.com/ post: summary: Assign Team Role operationId: teams-assign-role @@ -554,8 +512,6 @@ paths: $ref: '#/components/requestBodies/AssignRole' tags: - Roles - servers: - - url: https://global.api.konghq.com/ /teams/{teamId}/assigned-roles/{roleId}: parameters: - schema: @@ -593,8 +549,6 @@ paths: description: >- Removes an assigned role from a team. Returns 404 if the requested team or assigned role were not found. - servers: - - url: https://global.api.konghq.com/ /users: get: summary: List Users @@ -626,8 +580,6 @@ paths: description: Filter users returned in the response. required: false style: deepObject - servers: - - url: https://global.api.konghq.com/ /users/{userId}: parameters: - schema: @@ -651,8 +603,6 @@ paths: $ref: '#/components/responses/IdentityNotFound' operationId: get-user description: Returns the user object for the user ID specified as a path parameter. - servers: - - url: https://global.api.konghq.com/ patch: summary: Update User operationId: update-user @@ -670,8 +620,6 @@ paths: $ref: '#/components/requestBodies/UpdateUser' tags: - Users - servers: - - url: https://global.api.konghq.com/ delete: summary: Delete User operationId: delete-user @@ -685,8 +633,6 @@ paths: found. tags: - Users - servers: - - url: https://global.api.konghq.com/ /users/{userId}/teams: parameters: - schema: @@ -721,8 +667,6 @@ paths: style: deepObject tags: - Team Membership - servers: - - url: https://global.api.konghq.com/ /users/{userId}/assigned-roles: parameters: - schema: @@ -761,8 +705,6 @@ paths: description: Filter roles returned in the response. required: false style: deepObject - servers: - - url: https://global.api.konghq.com/ post: summary: Assign Role operationId: users-assign-role @@ -784,8 +726,6 @@ paths: $ref: '#/components/requestBodies/AssignRole' tags: - Roles - servers: - - url: https://global.api.konghq.com/ /users/{userId}/assigned-roles/{roleId}: parameters: - schema: @@ -821,8 +761,6 @@ paths: description: >- Removes an assigned role from a user. Returns 404 if the requested user or assigned role were not found. - servers: - - url: https://global.api.konghq.com/ /system-accounts: get: summary: List System Accounts @@ -858,8 +796,6 @@ paths: description: Filter system accounts returned in the response. required: false style: deepObject - servers: - - url: https://global.api.konghq.com/ post: summary: Create System Account operationId: post-system-accounts @@ -879,8 +815,6 @@ paths: $ref: '#/components/responses/Unauthorized' '409': $ref: '#/components/responses/IdentityConflict' - servers: - - url: https://global.api.konghq.com/ /system-accounts/{accountId}: get: summary: Fetch System Account @@ -899,8 +833,6 @@ paths: description: >- Returns the system account (SA) for the SA ID specified as a path parameter. - servers: - - url: https://global.api.konghq.com/ parameters: - schema: type: string @@ -929,8 +861,6 @@ paths: - System Accounts requestBody: $ref: '#/components/requestBodies/UpdateSystemAccount' - servers: - - url: https://global.api.konghq.com/ delete: summary: Delete System Account operationId: delete-system-accounts-id @@ -948,8 +878,6 @@ paths: account was not found. tags: - System Accounts - servers: - - url: https://global.api.konghq.com/ /system-accounts/{accountId}/access-tokens: get: summary: List System Account Access Tokens @@ -983,8 +911,6 @@ paths: description: Filter access tokens returned in the response. required: false style: deepObject - servers: - - url: https://global.api.konghq.com/ parameters: - schema: type: string @@ -1015,8 +941,6 @@ paths: $ref: '#/components/requestBodies/CreateSystemAccountAccessToken' tags: - System Accounts - Access Tokens - servers: - - url: https://global.api.konghq.com/ /system-accounts/{accountId}/access-tokens/{tokenId}: get: summary: Fetch System Account Access Token @@ -1036,8 +960,6 @@ paths: parameters: [] tags: - System Accounts - Access Tokens - servers: - - url: https://global.api.konghq.com/ parameters: - schema: type: string @@ -1072,8 +994,6 @@ paths: $ref: '#/components/requestBodies/UpdateSystemAccountAccessToken' tags: - System Accounts - Access Tokens - servers: - - url: https://global.api.konghq.com/ delete: summary: Delete System Account Access Token operationId: delete-system-accounts-id-access-tokens-id @@ -1089,8 +1009,6 @@ paths: description: Deletes the specified token. Returns 404 if the token was not found. tags: - System Accounts - Access Tokens - servers: - - url: https://global.api.konghq.com/ /system-accounts/{accountId}/assigned-roles: parameters: - schema: @@ -1131,8 +1049,6 @@ paths: style: deepObject tags: - System Accounts - Roles - servers: - - url: https://global.api.konghq.com/ post: summary: Create Assigned Role for System Account operationId: post-system-accounts-accountId-assigned-roles @@ -1154,8 +1070,6 @@ paths: $ref: '#/components/requestBodies/AssignRole' tags: - System Accounts - Roles - servers: - - url: https://global.api.konghq.com/ /system-accounts/{accountId}/assigned-roles/{roleId}: parameters: - schema: @@ -1187,8 +1101,6 @@ paths: system account or assigned role were not found. tags: - System Accounts - Roles - servers: - - url: https://global.api.konghq.com/ /teams/{teamId}/system-accounts: parameters: - schema: @@ -1227,8 +1139,6 @@ paths: style: deepObject tags: - System Accounts - Team Membership - servers: - - url: https://global.api.konghq.com/ post: summary: Add System Account to a Team operationId: post-teams-teamId-system-accounts @@ -1250,8 +1160,6 @@ paths: $ref: '#/components/requestBodies/AddSystemAccountToTeam' tags: - System Accounts - Team Membership - servers: - - url: https://global.api.konghq.com/ /teams/{teamId}/system-accounts/{accountId}: parameters: - schema: @@ -1283,8 +1191,6 @@ paths: account were not found. tags: - System Accounts - Team Membership - servers: - - url: https://global.api.konghq.com/ /system-accounts/{accountId}/teams: parameters: - schema: @@ -1321,8 +1227,6 @@ paths: style: deepObject tags: - System Accounts - Team Membership - servers: - - url: https://global.api.konghq.com/ /authenticate/{organizationLoginPath}: get: summary: SSO Callback @@ -1349,8 +1253,6 @@ paths: $ref: '#/components/responses/IdentityBadRequest' '401': $ref: '#/components/responses/IdentityUnauthenticated' - servers: - - url: https://global.api.konghq.com/ components: responses: GetImpersonationSettingsResponse: