Skip to content

Commit 39e44d7

Browse files
committed
rewrite description
change HTML to markdown where possible change title of first pages
1 parent c892454 commit 39e44d7

File tree

1 file changed

+37
-57
lines changed

1 file changed

+37
-57
lines changed

apify-api/openapi/components/tags.yaml

Lines changed: 37 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
- name: Actors
2-
x-displayName: Actors
2+
x-displayName: Actors - Introduction
33
x-legacy-doc-urls:
44
- '#/reference/actors'
55
- '#tag/Actors'
@@ -8,18 +8,12 @@
88
- '#/reference/actors/actor-object'
99
- '#tag/ActorsActor-object'
1010
description: |
11-
The API endpoints described in this section enable you to manage, build and run Apify Actors.
12-
For more information, see the <a href="https://docs.apify.com/platform/actors">Actor documentation</a>.
11+
The API endpoints in this section allow you to manage Apify Actors. For more details about Actors, refer to the [Actor documentation](https://docs.apify.com/platform/actors).
1312
14-
Note that for all the API endpoints that accept the `actorId` parameter to specify an Actor,
15-
you can pass either the Actor ID (e.g. `HG7ML7M8z78YcAPEB`) or a tilde-separated
16-
username of the Actor owner and the Actor name (e.g. `janedoe~my-actor`).
13+
For API endpoints that require the `actorId` parameter to identify an Actor, you can provide either:
14+
- The Actor ID (e.g., `HG7ML7M8z78YcAPEB`), or
15+
- A tilde-separated combination of the Actor owner's username and the Actor name (e.g., `janedoe~my-actor`).
1716
18-
Some of the API endpoints return runs objects. Note that if any such run object
19-
contains usage in dollars, your effective unit pricing at the time of query
20-
has been used for computation of this dollar equivalent, and hence it should be
21-
used only for informative purposes. You can learn more
22-
about platform usage in the <a href="https://docs.apify.com/platform/actors/running/usage-and-resources#usage">documentation</a>.
2317
- name: Actors/Actor versions
2418
x-displayName: Actor versions
2519
x-parent-tag-name: Actors
@@ -34,50 +28,20 @@
3428
- '#tag/ActorsEnvironment-variable-object'
3529
x-trait: 'true'
3630
description: |
37-
The **Version object** contains the source code of a specific version of an actor.
38-
The `sourceType` property indicates where the source code is hosted, and based
31+
The API endpoints in this section allow you to manage your Apify Actors versions.
32+
33+
- The _Version object_ contains the source code of a specific version of an Actor.
34+
- The `sourceType` property indicates where the source code is hosted, and based
3935
on its value the Version object has the following additional property:
4036
41-
<table>
42-
<tr>
43-
<td><code>"SOURCE_FILES"</code></td>
44-
<td>
45-
Source code is comprised of multiple files specified in the <code>sourceFiles</code> array.
46-
Each item of the array is an object with the following fields:<br />
47-
<ul>
48-
<li><code>name</code></li> - File path and name<br />
49-
<li><code>format</code></li> - Format of the content, can be either <code>"TEXT"</code>
50-
or <code>"BASE64"</code><br />
51-
<li><code>content</code></li> - File content<br />
52-
</ul>
53-
<br />
54-
Source files can be shown and edited in the Apify Console's Web IDE.
55-
</td>
56-
</tr>
57-
<tr>
58-
<td><code>"GIT_REPO"</code></td>
59-
<td>
60-
Source code is cloned from a Git repository, whose URL is specified in
61-
the <code>gitRepoUrl</code> field.
62-
</td>
63-
</tr>
64-
<tr>
65-
<td><code>"TARBALL"</code></td>
66-
<td>
67-
Source code is downloaded using a tarball or Zip file from a URL specified
68-
in the <code>tarballUrl</code> field.
69-
</td>
70-
</tr>
71-
<tr>
72-
<td><code>"GITHUB_GIST"</code></td>
73-
<td>
74-
Source code is taken from a GitHub Gist, whose URL is specified in the
75-
<code>gitHubGistUrl</code> field.
76-
</td>
77-
</tr>
78-
</table>
79-
80-
For more information about source code and Actor versions, see [Source code](https://docs.apify.com/platform/actors/development/actor-definition/source-code)
37+
| **Value** | **Description** |
38+
|---|---|
39+
| `"SOURCE_FILES"` | Source code is comprised of multiple files specified in the `sourceFiles` array. Each item of the array is an object with the following fields:<br/> - `name`: File path and name<br/> - `format`: Format of the content, can be either `"TEXT"` or `"BASE64"`<br/> - `content`: File content<br/><br/>Source files can be shown and edited in the Apify Console's Web IDE. |
40+
| `"GIT_REPO"` | Source code is cloned from a Git repository, whose URL is specified in the `gitRepoUrl` field. |
41+
| `"TARBALL"` | Source code is downloaded using a tarball or Zip file from a URL specified in the `tarballUrl` field. |
42+
|`"GITHUB_GIST"`| Source code is taken from a GitHub Gist, whose URL is specified in the `gitHubGistUrl` field. |
43+
44+
For more information about source code and Actor versions, check out [Source code](https://docs.apify.com/platform/actors/development/actor-definition/source-code)
8145
in Actors documentation.
8246
- name: Actors/Actor builds
8347
x-displayName: Actor builds
@@ -104,13 +68,21 @@
10468
- '#tag/ActorsRun-actor-synchronously'
10569
- '#/reference/actors/run-actor-synchronously-and-get-dataset-items'
10670
- '#tag/ActorsRun-Actor-synchronously-and-get-dataset-items'
71+
description: |
72+
The API endpoints in this section allow you to run Apify Actors.
73+
74+
Some API endpoints return run objects. If a run object includes usage costs in dollars, note that these values are calculated based on your effective unit pricing at the time of the query. As a result, the dollar amounts should be treated as informational only and not as exact figures.
75+
76+
For more information about platform usage and resource calculations, see the [Usage and Resources documentation](https://docs.apify.com/platform/actors/running/usage-and-resources#usage).
10777
x-trait: 'true'
10878
- name: Actors/Webhook collection
10979
x-displayName: Webhook collection
11080
x-parent-tag-name: Actors
11181
x-legacy-doc-urls:
11282
- '#/reference/actors/webhook-collection'
11383
- '#tag/ActorsWebhook-collection'
84+
description: |
85+
The API endpoint in this section allows you to get a list of webhooks of a specific Actor.
11486
x-trait: 'true'
11587
- name: Actors/Last run object and its storages
11688
x-displayName: Last run object and its storages
@@ -175,7 +147,7 @@
175147
176148
In order to save new items to the dataset, send HTTP POST request with JSON payload to the same URL.
177149
- name: Actor builds
178-
x-displayName: Introduction
150+
x-displayName: Actor builds - Introduction
179151
x-legacy-doc-urls:
180152
- '#/reference/actor-builds'
181153
- '#tag/Actor-builds'
@@ -188,14 +160,18 @@
188160
- '#/reference/actor-builds/build-log'
189161
- '#tag/Actor-buildsBuild-log'
190162
description: |
191-
The API endpoints described in this section enable you to manage Apify Actor builds.
163+
The API endpoints described in this section enable you to create, manage, and delete Apify Actor builds.
164+
165+
:::note
192166
193167
Note that if any returned build object contains usage in dollars, your effective
194168
unit pricing at the time of query has been used for computation of this dollar equivalent, and hence it should be
195169
used only for informative purposes.
196170
You can learn more about platform usage in the <a href="https://docs.apify.com/platform/actors/running/usage-and-resources#usage">documentation</a>.
171+
172+
:::
197173
- name: Actor runs
198-
x-displayName: Introduction
174+
x-displayName: Actor runs - Introduction
199175
x-legacy-doc-urls:
200176
- '#/reference/actor-runs'
201177
- '#tag/Actor-runs'
@@ -206,16 +182,20 @@
206182
description: |
207183
The API endpoints described in this section enable you to manage Apify Actor runs.
208184
185+
:::note
186+
209187
Note that if any returned run object contains usage in dollars, your effective unit pricing at the time of query
210188
has been used for computation of this dollar equivalent, and hence it should be used only for informative purposes.
211189
You can learn more about platform usage in the <a href="https://docs.apify.com/platform/actors/running/usage-and-resources#usage">documentation</a>.
190+
191+
:::
212192
- name: Key-value stores
213193
x-displayName: Key-value stores
214194
x-legacy-doc-urls:
215195
- '#/reference/key-value-stores'
216196
- '#tag/Key-value-stores'
217197
description: |
218-
This section describes API endpoints to manage Key-value stores.
198+
The API endpoints described in this section enable you to manage Key-value stores.
219199
Key-value store is a simple storage for saving and reading data records or files.
220200
Each data record is represented by a unique key and associated with a MIME content type.
221201
Key-value stores are ideal for saving screenshots, Actor inputs and outputs, web pages,

0 commit comments

Comments
 (0)