Add Actor Runtime API OpenAPI specification and documentation#84
Open
Add Actor Runtime API OpenAPI specification and documentation#84
Conversation
Define a standardized HTTP REST API that separates the front-end SDK from the back-end Actor runtime, enabling thin SDKs to be generated for any language and third-party runtime implementations. - Add openapi/openapi.json with full OpenAPI 3.1 specification covering: - Actor run management (status, abort, reboot, metamorph, charge) - Key-value store operations (get/set/delete records, list keys) - Dataset operations (push/get items, get-or-create named datasets) - Webhook attachment to Actor runs - Memory information endpoint - Update README.md with API code example tabs for each Actor programming interface operation - Add ACTOR_API_BASE_URL environment variable - Update Future work section to reflect completed API specification - Add OpenAPI spec link to Links section Closes #46 https://claude.ai/code/session_01J8Xb9hSAEuPoQj3EtDLcTf
Add a conventions note at the top of the Actor programming interface
section explaining auth, base URL, and content type once, then remove
the repetitive Authorization, Content-Type, and {ACTOR_API_BASE_URL}
prefix from all API code blocks.
https://claude.ai/code/session_01J8Xb9hSAEuPoQj3EtDLcTf
- Update Background section: replace "work in progress" language with a proper reference to the now-complete Actor Runtime API OpenAPI spec - Add a sentence to Actor programming interface section explaining that SDK operations map to the HTTP REST API defined in the OpenAPI spec - Expand Future work section with a bulleted list of what the OpenAPI spec covers (run management, KV stores, datasets, webhooks, memory) - Move the OpenAPI link out of the blockquote into the main prose https://claude.ai/code/session_01J8Xb9hSAEuPoQj3EtDLcTf
Contributor
|
I think this is a better place to discuss this than Slack, so... This document describes the Actor API, which is (more or less) implemented by the Apify API. What is the endgame plan for keeping this spec in sync with the Apify spec? |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR adds comprehensive OpenAPI 3.1.0 specification for the Actor Runtime API and integrates API usage examples throughout the Actor Programming Model documentation.
Solves #46
Key Changes
New OpenAPI Specification (
openapi/openapi.json): Complete REST API definition covering:Documentation Updates (
README.md): Added API usage examples alongside existing SDK examples for:ACTOR_API_BASE_URLenvironment variable documentationImplementation Details
APIFY_TOKENenvironment variable) or query parameter{ACTOR_API_BASE_URL},{ACTOR_RUN_ID}) for clarityhttps://claude.ai/code/session_01J8Xb9hSAEuPoQj3EtDLcTf