Commit 2a546f2
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- apify-api/openapi
- components/schemas
- actor-runs
- common
- datasets
- key-value-stores
- request-queues
- store
- paths
- actor-runs
- datasets
- key-value-stores
- request-queues
13 files changed
+48
-13
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
15 | 15 | | |
16 | 16 | | |
17 | 17 | | |
| 18 | + | |
18 | 19 | | |
19 | 20 | | |
20 | 21 | | |
| |||
66 | 67 | | |
67 | 68 | | |
68 | 69 | | |
| 70 | + | |
| 71 | + | |
69 | 72 | | |
70 | 73 | | |
71 | 74 | | |
| |||
Lines changed: 2 additions & 3 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | | - | |
3 | | - | |
4 | | - | |
5 | 2 | | |
6 | 3 | | |
7 | 4 | | |
| |||
13 | 10 | | |
14 | 11 | | |
15 | 12 | | |
| 13 | + | |
| 14 | + | |
Lines changed: 7 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
Lines changed: 2 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
77 | 77 | | |
78 | 78 | | |
79 | 79 | | |
| 80 | + | |
| 81 | + | |
80 | 82 | | |
81 | 83 | | |
Lines changed: 3 additions & 2 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | | - | |
3 | | - | |
4 | 2 | | |
5 | 3 | | |
6 | 4 | | |
7 | 5 | | |
| 6 | + | |
| 7 | + | |
8 | 8 | | |
9 | 9 | | |
| 10 | + | |
Lines changed: 2 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
51 | 51 | | |
52 | 52 | | |
53 | 53 | | |
| 54 | + | |
| 55 | + | |
54 | 56 | | |
55 | 57 | | |
Lines changed: 2 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
46 | 46 | | |
47 | 47 | | |
48 | 48 | | |
| 49 | + | |
| 50 | + | |
Lines changed: 3 additions & 2 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | | - | |
3 | | - | |
4 | 2 | | |
5 | 3 | | |
6 | 4 | | |
7 | 5 | | |
| 6 | + | |
| 7 | + | |
8 | 8 | | |
9 | 9 | | |
| 10 | + | |
Lines changed: 3 additions & 2 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | | - | |
3 | | - | |
4 | 2 | | |
5 | 3 | | |
6 | 4 | | |
7 | 5 | | |
| 6 | + | |
| 7 | + | |
8 | 8 | | |
9 | 9 | | |
| 10 | + | |
Lines changed: 17 additions & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
186 | 186 | | |
187 | 187 | | |
188 | 188 | | |
189 | | - | |
| 189 | + | |
190 | 190 | | |
| 191 | + | |
| 192 | + | |
| 193 | + | |
| 194 | + | |
191 | 195 | | |
192 | 196 | | |
193 | 197 | | |
| |||
196 | 200 | | |
197 | 201 | | |
198 | 202 | | |
| 203 | + | |
| 204 | + | |
| 205 | + | |
| 206 | + | |
| 207 | + | |
| 208 | + | |
| 209 | + | |
| 210 | + | |
| 211 | + | |
| 212 | + | |
| 213 | + | |
| 214 | + | |
199 | 215 | | |
200 | 216 | | |
201 | 217 | | |
| |||
0 commit comments