From abbd7d277ab41eba894e7dc2b9a784ffe2a19820 Mon Sep 17 00:00:00 2001 From: Daniil Poletaev <44584010+danpoletaev@users.noreply.github.com> Date: Fri, 5 Dec 2025 11:46:45 +0100 Subject: [PATCH] feat: update generalAccess docs --- .../components/schemas/actor-runs/Run.yaml | 8 ++++++++ .../schemas/actor-runs/UpdateRunRequest.yaml | 10 +++++++--- .../components/schemas/datasets/Dataset.yaml | 7 +++++++ .../schemas/datasets/UpdateDatasetRequest.yaml | 10 ++++++++-- .../key-value-stores/KeyValueStore.yaml | 7 +++++++ .../schemas/request-queues/RequestQueue.yaml | 7 +++++++ .../UpdateRequestQueueRequest.yaml | 10 ++++++++-- .../schemas/store/UpdateStoreRequest.yaml | 10 ++++++++-- .../paths/actor-runs/actor-runs@{runId}.yaml | 18 +++++++++++++++++- .../paths/datasets/datasets@{datasetId}.yaml | 3 ++- .../key-value-stores@{storeId}.yaml | 2 +- .../request-queues@{queueId}.yaml | 2 +- 12 files changed, 81 insertions(+), 13 deletions(-) diff --git a/apify-api/openapi/components/schemas/actor-runs/Run.yaml b/apify-api/openapi/components/schemas/actor-runs/Run.yaml index 18e2b04646..35871cede9 100644 --- a/apify-api/openapi/components/schemas/actor-runs/Run.yaml +++ b/apify-api/openapi/components/schemas/actor-runs/Run.yaml @@ -15,6 +15,7 @@ required: - defaultRequestQueueId - buildNumber - containerUrl + - generalAccess type: object properties: id: @@ -66,6 +67,13 @@ properties: type: number nullable: true example: 0 + generalAccess: + type: string + enum: + - RESTRICTED + - ANYONE_WITH_ID_CAN_READ + - FOLLOW_USER_SETTING + example: RESTRICTED defaultKeyValueStoreId: type: string example: eJNzqsbPiopwJcgGQ diff --git a/apify-api/openapi/components/schemas/actor-runs/UpdateRunRequest.yaml b/apify-api/openapi/components/schemas/actor-runs/UpdateRunRequest.yaml index 0f42791d1b..e1440d6f46 100644 --- a/apify-api/openapi/components/schemas/actor-runs/UpdateRunRequest.yaml +++ b/apify-api/openapi/components/schemas/actor-runs/UpdateRunRequest.yaml @@ -1,7 +1,4 @@ title: UpdateRunRequest -required: - - runId - - statusMessage type: object properties: runId: @@ -13,3 +10,10 @@ properties: isStatusMessageTerminal: type: boolean example: true + generalAccess: + type: string + enum: + - RESTRICTED + - ANYONE_WITH_ID_CAN_READ + - FOLLOW_USER_SETTING + example: RESTRICTED diff --git a/apify-api/openapi/components/schemas/datasets/Dataset.yaml b/apify-api/openapi/components/schemas/datasets/Dataset.yaml index beb63504aa..162d348fae 100644 --- a/apify-api/openapi/components/schemas/datasets/Dataset.yaml +++ b/apify-api/openapi/components/schemas/datasets/Dataset.yaml @@ -77,5 +77,12 @@ properties: type: string description: "A secret key for generating signed public URLs. It is only provided to clients with WRITE permission for the dataset." nullable: true + generalAccess: + type: string + enum: + - RESTRICTED + - ANYONE_WITH_ID_CAN_READ + - FOLLOW_USER_SETTING + example: RESTRICTED stats: $ref: ./DatasetStats.yaml diff --git a/apify-api/openapi/components/schemas/datasets/UpdateDatasetRequest.yaml b/apify-api/openapi/components/schemas/datasets/UpdateDatasetRequest.yaml index 31603822d3..f81ed5245e 100644 --- a/apify-api/openapi/components/schemas/datasets/UpdateDatasetRequest.yaml +++ b/apify-api/openapi/components/schemas/datasets/UpdateDatasetRequest.yaml @@ -1,9 +1,15 @@ title: UpdateDatasetRequest -required: - - name type: object properties: name: type: string + generalAccess: + type: string + enum: + - RESTRICTED + - ANYONE_WITH_ID_CAN_READ + - FOLLOW_USER_SETTING + example: RESTRICTED example: name: new-dataset-name + generalAccess: RESTRICTED diff --git a/apify-api/openapi/components/schemas/key-value-stores/KeyValueStore.yaml b/apify-api/openapi/components/schemas/key-value-stores/KeyValueStore.yaml index 378619c701..8d4e3eca32 100644 --- a/apify-api/openapi/components/schemas/key-value-stores/KeyValueStore.yaml +++ b/apify-api/openapi/components/schemas/key-value-stores/KeyValueStore.yaml @@ -51,5 +51,12 @@ properties: type: string description: "A secret key for generating signed public URLs. It is only provided to clients with WRITE permission for the key-value store." nullable: true + generalAccess: + type: string + enum: + - RESTRICTED + - ANYONE_WITH_ID_CAN_READ + - FOLLOW_USER_SETTING + example: RESTRICTED stats: $ref: ./KeyValueStoreStats.yaml diff --git a/apify-api/openapi/components/schemas/request-queues/RequestQueue.yaml b/apify-api/openapi/components/schemas/request-queues/RequestQueue.yaml index 972d4de061..df04db801e 100644 --- a/apify-api/openapi/components/schemas/request-queues/RequestQueue.yaml +++ b/apify-api/openapi/components/schemas/request-queues/RequestQueue.yaml @@ -46,3 +46,10 @@ properties: consoleUrl: type: string example: 'https://api.apify.com/v2/request-queues/27TmTznX9YPeAYhkC' + generalAccess: + type: string + enum: + - RESTRICTED + - ANYONE_WITH_ID_CAN_READ + - FOLLOW_USER_SETTING + example: RESTRICTED diff --git a/apify-api/openapi/components/schemas/request-queues/UpdateRequestQueueRequest.yaml b/apify-api/openapi/components/schemas/request-queues/UpdateRequestQueueRequest.yaml index 106b1d7fbd..af9964447b 100644 --- a/apify-api/openapi/components/schemas/request-queues/UpdateRequestQueueRequest.yaml +++ b/apify-api/openapi/components/schemas/request-queues/UpdateRequestQueueRequest.yaml @@ -1,9 +1,15 @@ title: UpdateRequestQueueRequest -required: - - name type: object properties: name: type: string + generalAccess: + type: string + enum: + - RESTRICTED + - ANYONE_WITH_ID_CAN_READ + - FOLLOW_USER_SETTING + example: RESTRICTED example: name: new-request-queue-name + generalAccess: RESTRICTED diff --git a/apify-api/openapi/components/schemas/store/UpdateStoreRequest.yaml b/apify-api/openapi/components/schemas/store/UpdateStoreRequest.yaml index 3f4662e22f..ee3da8d629 100644 --- a/apify-api/openapi/components/schemas/store/UpdateStoreRequest.yaml +++ b/apify-api/openapi/components/schemas/store/UpdateStoreRequest.yaml @@ -1,9 +1,15 @@ title: UpdateStoreRequest -required: - - name type: object properties: name: type: string + generalAccess: + type: string + enum: + - RESTRICTED + - ANYONE_WITH_ID_CAN_READ + - FOLLOW_USER_SETTING + example: RESTRICTED example: name: new-store-name + generalAccess: RESTRICTED diff --git a/apify-api/openapi/paths/actor-runs/actor-runs@{runId}.yaml b/apify-api/openapi/paths/actor-runs/actor-runs@{runId}.yaml index f7f53606b9..4f88cb3a5a 100644 --- a/apify-api/openapi/paths/actor-runs/actor-runs@{runId}.yaml +++ b/apify-api/openapi/paths/actor-runs/actor-runs@{runId}.yaml @@ -186,8 +186,12 @@ get: put: tags: - Actor runs - summary: Update status message + summary: Update run description: | + This endpoint can be used both to update the run’s status message and to configure its general resource access level. + + **Status message:** + You can set a single status message on your run that will be displayed in the Apify Console UI. During an Actor run, you will typically do this in order to inform users of your Actor about the Actor's progress. @@ -196,6 +200,18 @@ put: `isStatusMessageTerminal` property is optional and it indicates if the status message is the very last one. In the absence of a status message, the platform will try to substitute sensible defaults. + + **General resource access:** + + You can also update the run’s general resource access setting, which determines who can view the run and its related data. + + Allowed values: + + * `FOLLOW_USER_SETTING` - The run inherits the general access setting from the account-level. + * `ANYONE_WITH_ID_CAN_READ` - The run can be viewed anonymously by anyone who has its ID. + * `RESTRICTED` - Only users with explicit access to the resources can access the run. + + When a run is accessible anonymously, all of the run’s default storages and logs also become accessible anonymously. operationId: actorRun_put parameters: - name: runId diff --git a/apify-api/openapi/paths/datasets/datasets@{datasetId}.yaml b/apify-api/openapi/paths/datasets/datasets@{datasetId}.yaml index c1310bb889..6873b9fb54 100644 --- a/apify-api/openapi/paths/datasets/datasets@{datasetId}.yaml +++ b/apify-api/openapi/paths/datasets/datasets@{datasetId}.yaml @@ -71,7 +71,7 @@ put: - Storage/Datasets summary: Update dataset description: | - Updates a dataset's name using a value specified by a JSON object passed in the PUT payload. + Updates a dataset's name and general resource access level using a value specified by a JSON object passed in the PUT payload. The response is the updated dataset object, as returned by the [Get dataset](#/reference/datasets/dataset-collection/get-dataset) API endpoint. operationId: dataset_put parameters: @@ -91,6 +91,7 @@ put: $ref: ../../components/schemas/datasets/UpdateDatasetRequest.yaml example: name: new-dataset-name + generalAccess: RESTRICTED required: true responses: '200': diff --git a/apify-api/openapi/paths/key-value-stores/key-value-stores@{storeId}.yaml b/apify-api/openapi/paths/key-value-stores/key-value-stores@{storeId}.yaml index 7e0c73ed53..f0ae1cc3c6 100644 --- a/apify-api/openapi/paths/key-value-stores/key-value-stores@{storeId}.yaml +++ b/apify-api/openapi/paths/key-value-stores/key-value-stores@{storeId}.yaml @@ -39,7 +39,7 @@ put: - Storage/Key-value stores summary: Update store description: | - Updates a key-value store's name using a value specified by a JSON object + Updates a key-value store's name and general resource access level using a value specified by a JSON object passed in the PUT payload. The response is the updated key-value store object, as returned by the [Get diff --git a/apify-api/openapi/paths/request-queues/request-queues@{queueId}.yaml b/apify-api/openapi/paths/request-queues/request-queues@{queueId}.yaml index 2e5464287c..d04e9a266c 100644 --- a/apify-api/openapi/paths/request-queues/request-queues@{queueId}.yaml +++ b/apify-api/openapi/paths/request-queues/request-queues@{queueId}.yaml @@ -62,7 +62,7 @@ put: - Storage/Request queues summary: Update request queue description: | - Updates a request queue's name using a value specified by a JSON object + Updates a request queue's name and general resource access level using a value specified by a JSON object passed in the PUT payload. The response is the updated request queue object, as returned by the