docs: add web server schema (OpenAPI) reference page#2434
Open
docs: add web server schema (OpenAPI) reference page#2434
Conversation
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
|
Preview for this PR was built for commit |
|
Preview for this PR was built for commit |
Replace MCP field reference with webServerSchema, add Endpoints tab screenshot, fix passive voice, clarify standby mode requirement for schema definition vs. Endpoints tab display. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
|
Preview for this PR was built for commit |
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
|
Preview for this PR was built for commit |
|
Preview for this PR was built for commit |
nmanerikar
approved these changes
Apr 16, 2026
Contributor
nmanerikar
left a comment
nmanerikar
left a comment
There was a problem hiding this comment.
Looks good - the only issue is the tab name. Currently "Standby", but soon to be "Endpoints". See inline comment.
| sidebar_label: Web server schema | ||
| sidebar_position: 6.5 | ||
| description: >- | ||
| Attach an OpenAPI specification to your Actor to enable the interactive Endpoints tab in Apify Console and Apify Store, where you can browse and test endpoints. |
Contributor
There was a problem hiding this comment.
The tab is currently still named "Standby". I do have a change for it that will make it "Endpoints", but it will also change the copy a bit (to be the same as Store in Console and apify-web)
It means you will need to update the screenshot
Contributor
There was a problem hiding this comment.
any timeline for this ? I assume this docs have to ship before the changes you mention so we should use current labels and update accordingly once change happens
TC-MO
requested changes
Apr 18, 2026
| sidebar_label: Web server schema | ||
| sidebar_position: 6.5 | ||
| description: >- | ||
| Attach an OpenAPI specification to your Actor to enable the interactive Endpoints tab in Apify Console and Apify Store, where you can browse and test endpoints. |
Contributor
There was a problem hiding this comment.
any timeline for this ? I assume this docs have to ship before the changes you mention so we should use current labels and update accordingly once change happens
| title: Web server schema | ||
| sidebar_label: Web server schema | ||
| sidebar_position: 6.5 | ||
| description: >- |
| --- | ||
| title: Web server schema | ||
| sidebar_label: Web server schema | ||
| sidebar_position: 6.5 |
Contributor
There was a problem hiding this comment.
Can we not use decimals in sidebar position please?
| slug: /actors/development/actor-definition/web-server-schema | ||
| --- | ||
|
|
||
| The `webServerSchema` field in `.actor/actor.json` attaches an [OpenAPI 3.x](https://spec.openapis.org/oas/v3.0.3) specification to your Actor. You can define the schema for any Actor that exposes an HTTP server. When you enable [standby mode](/platform/actors/development/programming-interface/standby), Apify Console and Apify Store render an interactive **Endpoints** tab on the Actor's detail page, where you can browse endpoints, inspect request and response schemas, and send requests directly from the browser. |
Contributor
There was a problem hiding this comment.
This is Standby per screenshot, docs need to reflect current status
Suggested change
| The `webServerSchema` field in `.actor/actor.json` attaches an [OpenAPI 3.x](https://spec.openapis.org/oas/v3.0.3) specification to your Actor. You can define the schema for any Actor that exposes an HTTP server. When you enable [standby mode](/platform/actors/development/programming-interface/standby), Apify Console and Apify Store render an interactive **Endpoints** tab on the Actor's detail page, where you can browse endpoints, inspect request and response schemas, and send requests directly from the browser. | |
| The `webServerSchema` field in `.actor/actor.json` attaches an [OpenAPI 3.x](https://spec.openapis.org/oas/v3.0.3) specification to your Actor. You can define the schema for any Actor that exposes an HTTP server. When you enable [standby mode](/platform/actors/development/programming-interface/standby), Apify Console and Apify Store render an interactive **Standby** tab on the Actor's detail page. From there you can browse endpoints, inspect request and response schemas, and send requests directly from the browser. |
|
|
||
| ## Build and deploy | ||
|
|
||
| The platform validates `webServerSchema` at build time, similar to other Actor schemas like [input schema](/platform/actors/development/actor-definition/input-schema) and [dataset schema](/platform/actors/development/actor-definition/dataset-schema). If the spec is malformed, the build fails with a validation error. |
Contributor
There was a problem hiding this comment.
Suggested change
| The platform validates `webServerSchema` at build time, similar to other Actor schemas like [input schema](/platform/actors/development/actor-definition/input-schema) and [dataset schema](/platform/actors/development/actor-definition/dataset-schema). If the spec is malformed, the build fails with a validation error. | |
| The build process validates `webServerSchema`, similar to other Actor schemas like [input schema](/platform/actors/development/actor-definition/input-schema) and [dataset schema](/platform/actors/development/actor-definition/dataset-schema). If the spec is malformed, the build fails with a validation error. |
|
|
||
| :::note Servers field is overwritten | ||
|
|
||
| The platform replaces the `servers` array in your spec with the Actor's standby URL at display time. Custom server URLs are ignored. |
Contributor
There was a problem hiding this comment.
Suggested change
| The platform replaces the `servers` array in your spec with the Actor's standby URL at display time. Custom server URLs are ignored. | |
| Your `servers` array is replaced with the Actor's standby URL at display time. Custom server URLs are ignored. |
|
|
||
| The platform validates `webServerSchema` at build time, similar to other Actor schemas like [input schema](/platform/actors/development/actor-definition/input-schema) and [dataset schema](/platform/actors/development/actor-definition/dataset-schema). If the spec is malformed, the build fails with a validation error. | ||
|
|
||
| Once deployed, the **Endpoints** tab appears automatically on the Actor's detail page when you enable [standby mode](/platform/actors/development/programming-interface/standby). It renders your spec with [Swagger UI](https://swagger.io/tools/swagger-ui/) and handles authentication automatically - Actor users can send requests without configuring API tokens. |
Contributor
There was a problem hiding this comment.
Suggested change
| Once deployed, the **Endpoints** tab appears automatically on the Actor's detail page when you enable [standby mode](/platform/actors/development/programming-interface/standby). It renders your spec with [Swagger UI](https://swagger.io/tools/swagger-ui/) and handles authentication automatically - Actor users can send requests without configuring API tokens. | |
| Once deployed, the **Standby** tab appears automatically on the Actor's detail page when you enable [standby mode](/platform/actors/development/programming-interface/standby). It renders your spec with [Swagger UI](https://swagger.io/tools/swagger-ui/) and handles authentication automatically - Actor users can send requests without configuring API tokens. |
|
|
||
| | Field | Description | | ||
| | --- | --- | | ||
| | `usesStandbyMode` | Must be `true` for the **Endpoints** tab to appear. See [standby mode](/platform/actors/development/programming-interface/standby). | |
Contributor
There was a problem hiding this comment.
Suggested change
| | `usesStandbyMode` | Must be `true` for the **Endpoints** tab to appear. See [standby mode](/platform/actors/development/programming-interface/standby). | | |
| | `usesStandbyMode` | Must be `true` for the **Standby** tab to appear. See [standby mode](/platform/actors/development/programming-interface/standby). | |
| | Field | Description | | ||
| | --- | --- | | ||
| | `usesStandbyMode` | Must be `true` for the **Endpoints** tab to appear. See [standby mode](/platform/actors/development/programming-interface/standby). | | ||
| | `webServerSchema` | The OpenAPI spec that powers the **Endpoints** tab. Defined in [`.actor/actor.json`](/platform/actors/development/actor-definition/actor-json) as an inline object or a path to a JSON file. | |
Contributor
There was a problem hiding this comment.
Suggested change
| | `webServerSchema` | The OpenAPI spec that powers the **Endpoints** tab. Defined in [`.actor/actor.json`](/platform/actors/development/actor-definition/actor-json) as an inline object or a path to a JSON file. | | |
| | `webServerSchema` | The OpenAPI spec that powers the **Standby** tab. Defined in [`.actor/actor.json`](/platform/actors/development/actor-definition/actor-json) as an inline object or a path to a JSON file. | |
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
webServerSchemafield inactor.jsonStill TODO
🤖 Generated with Claude Code