Skip to content

Conversation

@danpoletaev
Copy link
Contributor

@danpoletaev danpoletaev commented Dec 5, 2025

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

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).

Written by Cursor Bugbot for commit abbd7d2. Configure here.

@danpoletaev danpoletaev requested review from TC-MO and stepskop December 5, 2025 10:49
@danpoletaev danpoletaev self-assigned this Dec 5, 2025
@danpoletaev danpoletaev added the adhoc Ad-hoc unplanned task added during the sprint. label Dec 5, 2025
@danpoletaev danpoletaev removed the request for review from fnesveda December 5, 2025 10:50
@github-actions github-actions bot added the t-core-services Issues with this label are in the ownership of the core services team. label Dec 5, 2025
@danpoletaev danpoletaev removed the request for review from janbuchar December 5, 2025 10:50
Comment on lines +70 to +76
generalAccess:
type: string
enum:
- RESTRICTED
- ANYONE_WITH_ID_CAN_READ
- FOLLOW_USER_SETTING
example: RESTRICTED
Copy link
Contributor

Choose a reason for hiding this comment

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

I believe that this enum could be extracted into the components and referenced here.

@apify-service-account
Copy link

Preview for this PR was built for commit abbd7d2 and is ready at https://pr-2127.preview.docs.apify.com!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

adhoc Ad-hoc unplanned task added during the sprint. t-core-services Issues with this label are in the ownership of the core services team.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants