Skip to content

Commit 695a18a

Browse files
janbucharjanbuchar
authored
fix(docs): Fix heading in output schema docs (#2164)
1 parent 890d837 commit 695a18a

1 file changed

Lines changed: 20 additions & 20 deletions

File tree

  • sources/platform/actors/development/actor_definition/output_schema

‎sources/platform/actors/development/actor_definition/output_schema/index.md‎

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -62,33 +62,33 @@ The output schema defines the collections of keys and their properties. It allow
6262

6363
| Property | Type | Required | Description |
6464
|-----------------------------------|-------------------------------|----------|-----------------------------------------------------------------------------------------------------------------|
65-
| `actorOutputSchemaVersion` | integer | true | Specifies the version of output schema structure document. <br/>Currently only version 1 is available. |
66-
| `title` | string | true | Title of the schema |
67-
| `description` | string | false | Description of the schema |
68-
| `properties` | Object | true | An object where each key is an output ID and its value is an output object definition (see below). |
65+
| `actorOutputSchemaVersion` | integer | true | Specifies the version of output schema structure document. <br/>Currently only version 1 is available. |
66+
| `title` | string | true | Title of the schema |
67+
| `description` | string | false | Description of the schema |
68+
| `properties` | Object | true | An object where each key is an output ID and its value is an Output object definition (see below). |
6969

70-
### Property object definition
70+
### Output object definition
7171

7272
| Property | Type | Required | Description |
7373
|----------------|--------------|--------------|-------------------------------------------------------------------------------------------------------------------------------------------------|
74-
| `title` | string | true | The output's title, shown in the run's output tab if there are multiple outputs and in API as key for the generated output URL. |
75-
| `description` | string | false | A description of the output. Only used when reading the schema (useful for LLMs) |
76-
| `template` | string | true | Defines a template which will be translated into output URL. The template can use variables (see below) |
74+
| `title` | string | true | The output's title, shown in the run's output tab if there are multiple outputs and in API as key for the generated output URL. |
75+
| `description` | string | false | A description of the output. Only used when reading the schema (useful for LLMs) |
76+
| `template` | string | true | Defines a template which will be translated into output URL. The template can use variables (see below) |
7777

7878
### Available template variables
7979

80-
| Variable | Type | Description |
81-
|----------------|--------------|--------------|
82-
| `links` | object | Contains quick links to most commonly used URLs |
83-
| `links.publicRunUrl` | string | Public run url in format `https://console.apify.com/view/runs/:runId` |
84-
| `links.consoleRunUrl` | string | Console run url in format `https://console.apify.com/actors/runs/:runId` |
85-
| `links.apiRunUrl` | string | API run url in format `https://api.apify.com/v2/actor-runs/:runId` |
86-
| `links.apiDefaultDatasetUrl` | string | API url of default dataset in format `https://api.apify.com/v2/datasets/:defaultDatasetId` |
87-
| `links.apiDefaultKeyValueStoreUrl` | string | API url of default key-value store in format `https://api.apify.com/v2/key-value-stores/:defaultKeyValueStoreId` |
88-
| `run` | object | Contains information about the run same as it is returned from the `GET Run` API endpoint |
89-
| `run.containerUrl` | string | URL of a webserver running inside the run in format `https://<containerId>.runs.apify.net/` |
90-
| `run.defaultDatasetId` | string | ID of the default dataset |
91-
| `run.defaultKeyValueStoreId` | string | ID of the default key-value store |
80+
| Variable | Type | Description |
81+
|------------------------------------|--------|----------------------------------------------------------------------------------------------------------------------------------|
82+
| `links` | object | Contains quick links to most commonly used URLs |
83+
| `links.publicRunUrl` | string | Public run url in format `https://console.apify.com/view/runs/:runId` |
84+
| `links.consoleRunUrl` | string | Console run url in format `https://console.apify.com/actors/runs/:runId` |
85+
| `links.apiRunUrl` | string | API run url in format `https://api.apify.com/v2/actor-runs/:runId` |
86+
| `links.apiDefaultDatasetUrl` | string | API url of default dataset in format `https://api.apify.com/v2/datasets/:defaultDatasetId` |
87+
| `links.apiDefaultKeyValueStoreUrl` | string | API url of default key-value store in format `https://api.apify.com/v2/key-value-stores/:defaultKeyValueStoreId` |
88+
| `run` | object | Contains information about the run same as it is returned from the `GET Run` API endpoint |
89+
| `run.containerUrl` | string | URL of a webserver running inside the run in format `https://<containerId>.runs.apify.net/` |
90+
| `run.defaultDatasetId` | string | ID of the default dataset |
91+
| `run.defaultKeyValueStoreId` | string | ID of the default key-value store |
9292

9393
## Examples
9494

0 commit comments

Comments
 (0)