Skip to content

Commit 2a546f2

Browse files
feat: update generalAccess docs (#2127)
We noticed that we don't have information about updating `generalAccess` in docs. This PR updates docs to include `generalAccess` for update(PUT) endpoints of: - KV stores - RQ - Datasets - Runs <!-- CURSOR_SUMMARY --> --- > [!NOTE] > Documents and exposes `generalAccess` in schemas and PUT endpoints for runs, datasets, key‑value stores, and request queues, and expands the run update endpoint to cover both status and access. > > - **OpenAPI Schemas**: > - `actor-runs/Run.yaml`: Add `generalAccess` (enum) and include it in `required`. > - Add `generalAccess` (enum) to `datasets/Dataset.yaml`, `key-value-stores/KeyValueStore.yaml`, `request-queues/RequestQueue.yaml`. > - Update request schemas to accept `generalAccess` (with examples): `datasets/UpdateDatasetRequest.yaml`, `request-queues/UpdateRequestQueueRequest.yaml`, `store/UpdateStoreRequest.yaml`, `actor-runs/UpdateRunRequest.yaml`. > - **PUT Endpoints**: > - `datasets@{datasetId}.yaml`, `key-value-stores@{storeId}.yaml`, `request-queues@{queueId}.yaml`: Update descriptions to allow updating `name` and `generalAccess`; add `generalAccess` to request examples. > - `actor-runs@{runId}.yaml`: Rename summary to "Update run" and expand description to cover `statusMessage` and `generalAccess` (allowed values, effects). > > <sup>Written by [Cursor Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit abbd7d2. Configure [here](https://cursor.com/dashboard?tab=bugbot).</sup> <!-- /CURSOR_SUMMARY --> --------- Co-authored-by: Marcel Rebro <[email protected]>
1 parent a5a3bee commit 2a546f2

File tree

13 files changed

+48
-13
lines changed

13 files changed

+48
-13
lines changed

apify-api/openapi/components/schemas/actor-runs/Run.yaml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ required:
1515
- defaultRequestQueueId
1616
- buildNumber
1717
- containerUrl
18+
- generalAccess
1819
type: object
1920
properties:
2021
id:
@@ -66,6 +67,8 @@ properties:
6667
type: number
6768
nullable: true
6869
example: 0
70+
generalAccess:
71+
$ref: ../common/GeneralAccessEnum.yaml
6972
defaultKeyValueStoreId:
7073
type: string
7174
example: eJNzqsbPiopwJcgGQ

apify-api/openapi/components/schemas/actor-runs/UpdateRunRequest.yaml

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,4 @@
11
title: UpdateRunRequest
2-
required:
3-
- runId
4-
- statusMessage
52
type: object
63
properties:
74
runId:
@@ -13,3 +10,5 @@ properties:
1310
isStatusMessageTerminal:
1411
type: boolean
1512
example: true
13+
generalAccess:
14+
$ref: ../common/GeneralAccessEnum.yaml
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
type: string
2+
enum:
3+
- RESTRICTED
4+
- ANYONE_WITH_ID_CAN_READ
5+
- FOLLOW_USER_SETTING
6+
example: RESTRICTED
7+
description: Defines the general access level for the resource.

apify-api/openapi/components/schemas/datasets/Dataset.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,5 +77,7 @@ properties:
7777
type: string
7878
description: "A secret key for generating signed public URLs. It is only provided to clients with WRITE permission for the dataset."
7979
nullable: true
80+
generalAccess:
81+
$ref: ../common/GeneralAccessEnum.yaml
8082
stats:
8183
$ref: ./DatasetStats.yaml
Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
title: UpdateDatasetRequest
2-
required:
3-
- name
42
type: object
53
properties:
64
name:
75
type: string
6+
generalAccess:
7+
$ref: ../common/GeneralAccessEnum.yaml
88
example:
99
name: new-dataset-name
10+
generalAccess: RESTRICTED

apify-api/openapi/components/schemas/key-value-stores/KeyValueStore.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,5 +51,7 @@ properties:
5151
type: string
5252
description: "A secret key for generating signed public URLs. It is only provided to clients with WRITE permission for the key-value store."
5353
nullable: true
54+
generalAccess:
55+
$ref: ../common/GeneralAccessEnum.yaml
5456
stats:
5557
$ref: ./KeyValueStoreStats.yaml

apify-api/openapi/components/schemas/request-queues/RequestQueue.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,3 +46,5 @@ properties:
4646
consoleUrl:
4747
type: string
4848
example: 'https://api.apify.com/v2/request-queues/27TmTznX9YPeAYhkC'
49+
generalAccess:
50+
$ref: ../common/GeneralAccessEnum.yaml
Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
title: UpdateRequestQueueRequest
2-
required:
3-
- name
42
type: object
53
properties:
64
name:
75
type: string
6+
generalAccess:
7+
$ref: ../common/GeneralAccessEnum.yaml
88
example:
99
name: new-request-queue-name
10+
generalAccess: RESTRICTED
Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
title: UpdateStoreRequest
2-
required:
3-
- name
42
type: object
53
properties:
64
name:
75
type: string
6+
generalAccess:
7+
$ref: ../common/GeneralAccessEnum.yaml
88
example:
99
name: new-store-name
10+
generalAccess: RESTRICTED

apify-api/openapi/paths/actor-runs/actor-runs@{runId}.yaml

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -186,8 +186,12 @@ get:
186186
put:
187187
tags:
188188
- Actor runs
189-
summary: Update status message
189+
summary: Update run
190190
description: |
191+
This endpoint can be used to update both the run's status message and to configure its general resource access level.
192+
193+
**Status message:**
194+
191195
You can set a single status message on your run that will be displayed in
192196
the Apify Console UI. During an Actor run, you will typically do this in order
193197
to inform users of your Actor about the Actor's progress.
@@ -196,6 +200,18 @@ put:
196200
`isStatusMessageTerminal` property is optional and it indicates if the
197201
status message is the very last one. In the absence of a status message, the
198202
platform will try to substitute sensible defaults.
203+
204+
**General resource access:**
205+
206+
You can also update the run's general resource access setting, which determines who can view the run and its related data.
207+
208+
Allowed values:
209+
210+
* `FOLLOW_USER_SETTING` - The run inherits the general access setting from the account level.
211+
* `ANYONE_WITH_ID_CAN_READ` - The run can be viewed anonymously by anyone who has its ID.
212+
* `RESTRICTED` - Only users with explicit access to the resource can access the run.
213+
214+
When a run is accessible anonymously, all of the run's default storages and logs also become accessible anonymously.
199215
operationId: actorRun_put
200216
parameters:
201217
- name: runId

0 commit comments

Comments
 (0)