From 8b59f65fccaea3ba81d9726f39f7c176d0144c4e Mon Sep 17 00:00:00 2001 From: martinforejt Date: Sun, 20 Oct 2024 19:57:59 +0200 Subject: [PATCH] docs(api): Add missing update users limits endpoint --- .../schemas/users/UpdateLimitsRequest.yaml | 16 +++++++++++++ openapi/paths/users/users@me@limits.yaml | 23 +++++++++++++++++++ 2 files changed, 39 insertions(+) create mode 100644 openapi/components/schemas/users/UpdateLimitsRequest.yaml diff --git a/openapi/components/schemas/users/UpdateLimitsRequest.yaml b/openapi/components/schemas/users/UpdateLimitsRequest.yaml new file mode 100644 index 0000000..84432d4 --- /dev/null +++ b/openapi/components/schemas/users/UpdateLimitsRequest.yaml @@ -0,0 +1,16 @@ +title: UpdateLimitsRequest +type: object +properties: + maxMonthlyUsageUsd: + type: number + example: 300 + description: | + If your platform usage in the billing period exceeds the prepaid usage, you will be charged extra. + Setting this property you can update your hard limit on monthly platform usage to prevent accidental overage or to limit the extra charges + dataRetentionDays: + type: number + example: 90 + description: | + Apify securely stores your ten most recent Actor runs indefinitely, ensuring they are always accessible. + Unnamed storages and other Actor runs are automatically deleted after the retention period. + If you're subscribed, you can change it to keep data for longer or to limit your usage. [Lear more](https://docs.apify.com/platform/storage/usage#data-retention) diff --git a/openapi/paths/users/users@me@limits.yaml b/openapi/paths/users/users@me@limits.yaml index 16f1dc9..e165e31 100644 --- a/openapi/paths/users/users@me@limits.yaml +++ b/openapi/paths/users/users@me@limits.yaml @@ -18,3 +18,26 @@ get: deprecated: false x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/users/account-and-usage-limits/get-limits +put: + tags: + - Users/Account and usage limits + summary: Update limits + description: | + Updates the account's limits manageable on your account's [Limits page](https://console.apify.com/billing#/limits). + Specifically the: `maxMonthlyUsageUsd` and `dataRetentionDays` limits (see request body schema for more details). + operationId: users_me_limits_put + requestBody: + description: '' + content: + application/json: + schema: + $ref: ../../components/schemas/users/UpdateLimitsRequest.yaml + responses: + '201': + description: '' + headers: {} + content: + application/json: + schema: + type: object + deprecated: false