docs(apify-actor-development): declare Standby API via webServerSchema and self-serve /openapi.json#72
Draft
DaveHanns wants to merge 1 commit into
Conversation
…ma` and self-serve `/openapi.json`
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
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.
The current
## Standby modesection inskills/apify-actor-development/SKILL.mdtells agents to setusesStandbyMode: trueand implement an HTTP server, then defers everything else toreferences/standby-mode.md. Two teachings that materially improve every Standby Actor are missing from the primary skill:webServerSchemain.actor/actor.json— Apify's canonical OpenAPI 3.x field. Declaring it gets a Console "Standby" tab rendered as Swagger UI for free and makes the Actor discoverable to programmatic OpenAPI consumers./openapi.jsonon the HTTP server itself — the platform does not currently auto-serve the schema at a conventional path on the public Standby URL, so a curl-and-go client that only has the Standby URL cannot fetch the schema unless the server exposes it directly.This PR expands
## Standby modewith two short paragraphs covering both points, keeping the existingreferences/standby-mode.mdlink in place for the deeper reference material.Added content (verbatim)
Surfaced during an evaluation of Apify surfaces for agent-driven Actor development.