Skip to content

docs: add actorPermissionLevel to OpenAPI spec #2135

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
stepskop merged 6 commits into from
Dec 12, 2025
Merged

docs: add actorPermissionLevel to OpenAPI spec #2135

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
bb08633
docs: add `actorPermissionLevel` to OpenAPI spec
stepskop Dec 8, 2025
9fabbfa
chore: make the response not nullable
stepskop Dec 8, 2025
e0e5ad5
Merge branch 'master' into docs/api-actor-permission-level
stepskop Dec 12, 2025
50018ad
chore: make permission level reusable component
stepskop Dec 12, 2025
604a735
chore: add description to permission level
stepskop Dec 12, 2025
bd8c424
chore: permission level copy
stepskop Dec 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions apify-api/openapi/components/schemas/actors/Actor.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,8 @@ properties:
isPublic:
type: boolean
example: false
actorPermissionLevel:
$ref: ./ActorPermissionLevel.yaml
createdAt:
type: string
example: '2019-07-08T11:27:57.401Z'
Expand Down
8 changes: 8 additions & 0 deletions apify-api/openapi/components/schemas/actors/ActorPermissionLevel.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
type: string
description: >
Determines permissions that the Actor requires to run.
For more information, see the [Actor permissions documentation](https://docs.apify.com/platform/actors/development/permissions).
enum:
- LIMITED_PERMISSIONS
- FULL_PERMISSIONS
example: LIMITED_PERMISSIONS
4 changes: 3 additions & 1 deletion apify-api/openapi/components/schemas/actors/UpdateActorRequest.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@ properties:
isPublic:
type: boolean
example: false
actorPermissionLevel:
nullable: true
Copy link
Member

@barjin barjin Dec 9, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we add a description field with a simple text description (to both locations)? A few words and a link to docs would suffice really :)

$ref: ./ActorPermissionLevel.yaml
seoTitle:
type: string
nullable: true
Expand Down Expand Up @@ -102,4 +105,3 @@ required:
- name
- isPublic
- versions

2 changes: 2 additions & 0 deletions apify-api/openapi/paths/actors/acts@{actorId}.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,6 +140,7 @@ put:
name: MyActor
description: My favourite Actor!
isPublic: false
actorPermissionLevel: 'LIMITED_PERMISSIONS'
seoTitle: My Actor
seoDescription: My Actor is the best
title: My Actor
Expand Down Expand Up @@ -197,6 +198,7 @@ put:
username: jane35
description: My favourite Actor!
isPublic: false
actorPermissionLevel: 'LIMITED_PERMISSIONS'
createdAt: '2019-07-08T11:27:57.401Z'
modifiedAt: '2019-07-08T14:01:05.546Z'
stats:
Expand Down
Loading