Skip to content

Commit a5a3bee

Browse files
authored
docs: add actorPermissionLevel to API reference (#2135)
Adds missing `actorPermissionLevel` to the Actor's OpenAPI spec. <!-- CURSOR_SUMMARY --> --- > [!NOTE] > Adds `actorPermissionLevel` enum field to `Actor` and `UpdateActorRequest` schemas and includes it in Update Actor request/response examples. > > - **OpenAPI Schemas**: > - `components/schemas/actors/Actor.yaml`: Add `actorPermissionLevel` (`LIMITED_PERMISSIONS` | `FULL_PERMISSIONS`, nullable) with example. > - `components/schemas/actors/UpdateActorRequest.yaml`: Add `actorPermissionLevel` (same enum/nullable) with example. > - **Paths**: > - `paths/actors/acts@{actorId}.yaml` (PUT Update Actor): Include `actorPermissionLevel` in request body example and response example. > > <sup>Written by [Cursor Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit bb08633. Configure [here](https://cursor.com/dashboard?tab=bugbot).</sup> <!-- /CURSOR_SUMMARY -->
1 parent b22ffcf commit a5a3bee

File tree

4 files changed

+15
-1
lines changed

4 files changed

+15
-1
lines changed

apify-api/openapi/components/schemas/actors/Actor.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,8 @@ properties:
3636
isPublic:
3737
type: boolean
3838
example: false
39+
actorPermissionLevel:
40+
$ref: ./ActorPermissionLevel.yaml
3941
createdAt:
4042
type: string
4143
example: '2019-07-08T11:27:57.401Z'
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
type: string
2+
description: >
3+
Determines permissions that the Actor requires to run.
4+
For more information, see the [Actor permissions documentation](https://docs.apify.com/platform/actors/development/permissions).
5+
enum:
6+
- LIMITED_PERMISSIONS
7+
- FULL_PERMISSIONS
8+
example: LIMITED_PERMISSIONS

apify-api/openapi/components/schemas/actors/UpdateActorRequest.yaml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,9 @@ properties:
1111
isPublic:
1212
type: boolean
1313
example: false
14+
actorPermissionLevel:
15+
nullable: true
16+
$ref: ./ActorPermissionLevel.yaml
1417
seoTitle:
1518
type: string
1619
nullable: true
@@ -102,4 +105,3 @@ required:
102105
- name
103106
- isPublic
104107
- versions
105-

apify-api/openapi/paths/actors/acts@{actorId}.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -140,6 +140,7 @@ put:
140140
name: MyActor
141141
description: My favourite Actor!
142142
isPublic: false
143+
actorPermissionLevel: 'LIMITED_PERMISSIONS'
143144
seoTitle: My Actor
144145
seoDescription: My Actor is the best
145146
title: My Actor
@@ -197,6 +198,7 @@ put:
197198
username: jane35
198199
description: My favourite Actor!
199200
isPublic: false
201+
actorPermissionLevel: 'LIMITED_PERMISSIONS'
200202
createdAt: '2019-07-08T11:27:57.401Z'
201203
modifiedAt: '2019-07-08T14:01:05.546Z'
202204
stats:

0 commit comments

Comments
 (0)