From 6e066fdff5238ce1d5e148c54c61fa35953491ae Mon Sep 17 00:00:00 2001 From: Daniel DeGroff Date: Thu, 10 Jul 2025 16:03:20 -0600 Subject: [PATCH] Rebuild clients based due to changes in fusionauth-client-builder --- openapi.yaml | 145 ++++++++++++++++++++++++++++++--------------------- 1 file changed, 86 insertions(+), 59 deletions(-) diff --git a/openapi.yaml b/openapi.yaml index 0e18d9697..11781ceec 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -9230,17 +9230,22 @@ paths: application/json: schema: "$ref": "#/components/schemas/Errors" - "/api/api-key/{apiKeyId}": - put: - description: Updates an API key by given id - operationId: updateAPIKeyWithId + "/api/api-key/{keyId}": + post: + description: Creates an API key. You can optionally specify a unique Id for + the key, if not provided one will be generated. an API key can only be created + with equal or lesser authority. An API key cannot create another API key unless + it is granted to that API key. If an API key is locked to a tenant, it can + only create API Keys for that same tenant. + operationId: createAPIKeyWithId parameters: - - name: apiKeyId + - name: keyId in: path schema: type: string required: true - description: The Id of the API key to update. + description: The unique Id of the API key. If not provided a secure random + Id will be generated. requestBody: content: application/json: @@ -9259,23 +9264,36 @@ paths: application/json: schema: "$ref": "#/components/schemas/Errors" - "/api/api-key/{keyId}": - post: - description: Updates an authentication API key by given id OR Creates an API - key. You can optionally specify a unique Id for the key, if not provided one - will be generated. an API key can only be created with equal or lesser authority. - An API key cannot create another API key unless it is granted to that API - key. If an API key is locked to a tenant, it can only create API Keys for - that same tenant. - operationId: createApiKeyWithId + delete: + description: Deletes the API key for the given Id. + operationId: deleteAPIKeyWithId + parameters: + - name: keyId + in: path + schema: + type: string + required: true + description: The Id of the authentication API key to delete. + responses: + '200': + description: Success + default: + description: Error + content: + application/json: + schema: + "$ref": "#/components/schemas/Errors" + patch: + description: Updates an API key with the given Id. + operationId: patchAPIKeyWithId parameters: - name: keyId in: path schema: type: string required: true - description: The Id of the authentication key. If not provided a secure random - api key will be generated. + description: The Id of the API key. If not provided a secure random api key + will be generated. requestBody: content: application/json: @@ -9294,35 +9312,44 @@ paths: application/json: schema: "$ref": "#/components/schemas/Errors" - delete: - description: Deletes the API key for the given Id. - operationId: deleteAPIKeyWithId + get: + description: Retrieves an authentication API key for the given Id. + operationId: retrieveAPIKeyWithId parameters: - name: keyId in: path schema: type: string required: true - description: The Id of the authentication API key to delete. + description: The Id of the API key to retrieve. responses: '200': description: Success + content: + application/json: + schema: + "$ref": "#/components/schemas/APIKeyResponse" default: description: Error content: application/json: schema: "$ref": "#/components/schemas/Errors" - get: - description: Retrieves an authentication API key for the given id - operationId: retrieveAPIKeyWithId + put: + description: Updates an API key with the given Id. + operationId: updateAPIKeyWithId parameters: - name: keyId in: path schema: type: string required: true - description: The Id of the API key to retrieve. + description: The Id of the API key to update. + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/APIKeyRequest" responses: '200': description: Success @@ -9581,7 +9608,7 @@ paths: schema: type: string required: true - description: The application id. + description: The application Id. - in: header name: X-FusionAuth-TenantId description: The unique Id of the tenant used to scope this API request. Only @@ -10454,7 +10481,7 @@ paths: "$ref": "#/components/schemas/Errors" "/api/email/send/{emailTemplateId}": post: - description: Send an email using an email template id. You can optionally provide + description: Send an email using an email template Id. You can optionally provide requestData to access key value pairs in the email template. operationId: sendEmailWithId parameters: @@ -10516,7 +10543,7 @@ paths: "$ref": "#/components/schemas/Errors" get: description: Retrieves the email template for the given Id. If you don't specify - the id, this will return all the email templates. + the Id, this will return all the email templates. operationId: retrieveEmailTemplate parameters: - in: header @@ -10689,7 +10716,7 @@ paths: "$ref": "#/components/schemas/Errors" get: description: Retrieves the email template for the given Id. If you don't specify - the id, this will return all the email templates. + the Id, this will return all the email templates. operationId: retrieveEmailTemplateWithId parameters: - name: emailTemplateId @@ -10830,7 +10857,7 @@ paths: schema: "$ref": "#/components/schemas/Errors" get: - description: Retrieves the entities for the given ids. If any Id is invalid, + description: Retrieves the entities for the given Ids. If any Id is invalid, it is ignored. operationId: searchEntitiesByIdsWithId parameters: @@ -13582,7 +13609,7 @@ paths: "$ref": "#/components/schemas/Errors" get: description: Retrieves the message template for the given Id. If you don't specify - the id, this will return all the message templates. + the Id, this will return all the message templates. operationId: retrieveMessageTemplate parameters: [] responses: @@ -13698,7 +13725,7 @@ paths: "$ref": "#/components/schemas/Errors" get: description: Retrieves the message template for the given Id. If you don't specify - the id, this will return all the message templates. + the Id, this will return all the message templates. operationId: retrieveMessageTemplateWithId parameters: - name: messageTemplateId @@ -13999,7 +14026,7 @@ paths: "/api/report/daily-active-user": get: description: Retrieves the daily active user report between the two instants. - If you specify an application id, it will only return the daily active counts + If you specify an application Id, it will only return the daily active counts for that application. operationId: retrieveDailyActiveReportWithId parameters: @@ -14007,7 +14034,7 @@ paths: in: query schema: type: string - description: The application id. + description: The application Id. - name: start in: query schema: @@ -14034,11 +14061,11 @@ paths: "/api/report/login": get: description: Retrieves the login report between the two instants for a particular - user by login Id. If you specify an application id, it will only return the + user by login Id. If you specify an application Id, it will only return the login counts for that application. OR Retrieves the login report between the - two instants for a particular user by Id. If you specify an application id, + two instants for a particular user by Id. If you specify an application Id, it will only return the login counts for that application. OR Retrieves the - login report between the two instants. If you specify an application id, it + login report between the two instants. If you specify an application Id, it will only return the login counts for that application. operationId: retrieveReportLogin parameters: @@ -14046,12 +14073,12 @@ paths: in: query schema: type: string - description: The application id. + description: The application Id. - name: loginId in: query schema: type: string - description: The userId id. + description: The userId Id. - name: start in: query schema: @@ -14066,7 +14093,7 @@ paths: in: query schema: type: string - description: The userId id. + description: The userId Id. responses: '200': description: Success @@ -14083,7 +14110,7 @@ paths: "/api/report/monthly-active-user": get: description: Retrieves the monthly active user report between the two instants. - If you specify an application id, it will only return the monthly active counts + If you specify an application Id, it will only return the monthly active counts for that application. operationId: retrieveMonthlyActiveReportWithId parameters: @@ -14091,7 +14118,7 @@ paths: in: query schema: type: string - description: The application id. + description: The application Id. - name: start in: query schema: @@ -14118,7 +14145,7 @@ paths: "/api/report/registration": get: description: Retrieves the registration report between the two instants. If - you specify an application id, it will only return the registration counts + you specify an application Id, it will only return the registration counts for that application. operationId: retrieveRegistrationReportWithId parameters: @@ -14126,7 +14153,7 @@ paths: in: query schema: type: string - description: The application id. + description: The application Id. - name: start in: query schema: @@ -15225,7 +15252,7 @@ paths: "$ref": "#/components/schemas/Errors" get: description: Retrieves the user action for the given Id. If you pass in null - for the id, this will return all the user actions. OR Retrieves all the user + for the Id, this will return all the user actions. OR Retrieves all the user actions that are currently inactive. operationId: retrieveUserAction parameters: @@ -15277,7 +15304,7 @@ paths: "$ref": "#/components/schemas/Errors" get: description: Retrieves the user action reason for the given Id. If you pass - in null for the id, this will return all the user action reasons. + in null for the Id, this will return all the user action reasons. operationId: retrieveUserActionReason parameters: [] responses: @@ -15370,7 +15397,7 @@ paths: "$ref": "#/components/schemas/Errors" get: description: Retrieves the user action reason for the given Id. If you pass - in null for the id, this will return all the user action reasons. + in null for the Id, this will return all the user action reasons. operationId: retrieveUserActionReasonWithId parameters: - name: userActionReasonId @@ -15568,7 +15595,7 @@ paths: "$ref": "#/components/schemas/Errors" get: description: Retrieves the user action for the given Id. If you pass in null - for the id, this will return all the user actions. + for the Id, this will return all the user actions. operationId: retrieveUserActionWithId parameters: - name: userActionId @@ -15697,7 +15724,7 @@ paths: type: string required: true description: The Id of the action to modify. This is technically the user - action log id. + action log Id. requestBody: content: application/json: @@ -15742,13 +15769,13 @@ paths: "$ref": "#/components/schemas/Errors" "/api/user/bulk": delete: - description: Deletes the users with the given ids, or users matching the provided - JSON query or queryString. The order of preference is ids, query and then + description: Deletes the users with the given Ids, or users matching the provided + JSON query or queryString. The order of preference is Ids, query and then queryString, it is recommended to only provide one of the three for the request. This method can be used to deactivate or permanently delete (hard-delete) users based upon the hardDelete boolean in the request body. Using the dryRun parameter you may also request the result of the action without actually deleting or - deactivating any users. OR Deactivates the users with the given ids. + deactivating any users. OR Deactivates the users with the given Ids. operationId: deleteUserBulk parameters: - name: userIds @@ -16353,7 +16380,7 @@ paths: description: Error "/api/user/family/{familyId}/{userId}": delete: - description: Removes a user from the family with the given id. + description: Removes a user from the family with the given Id. operationId: removeUserFromFamilyWithId parameters: - name: familyId @@ -16696,7 +16723,7 @@ paths: "$ref": "#/components/schemas/Errors" get: description: Retrieves the user registration for the user with the given Id - and the given application id. + and the given application Id. operationId: retrieveRegistrationWithId parameters: - name: userId @@ -16734,7 +16761,7 @@ paths: "$ref": "#/components/schemas/Errors" "/api/user/search": get: - description: Retrieves the users for the given ids. If any Id is invalid, it + description: Retrieves the users for the given Ids. If any Id is invalid, it is ignored. operationId: searchUsersByIdsWithId parameters: @@ -16742,7 +16769,7 @@ paths: in: query schema: type: string - description: The user ids to search for. + description: The user Ids to search for. responses: '200': description: Success @@ -17436,7 +17463,7 @@ paths: "$ref": "#/components/schemas/Errors" get: description: Retrieves the webhook for the given Id. If you pass in null for - the id, this will return all the webhooks. + the Id, this will return all the webhooks. operationId: retrieveWebhook parameters: [] responses: @@ -17551,7 +17578,7 @@ paths: "$ref": "#/components/schemas/Errors" get: description: Retrieves the webhook for the given Id. If you pass in null for - the id, this will return all the webhooks. + the Id, this will return all the webhooks. operationId: retrieveWebhookWithId parameters: - name: webhookId @@ -17647,7 +17674,7 @@ paths: in: query schema: type: string - description: The client id. + description: The client Id. responses: '200': description: Success