Skip to content

Commit

Permalink
remove extra blank lines
Browse files Browse the repository at this point in the history
  • Loading branch information
B4nan committed Jan 14, 2025
1 parent 5c6f9cd commit eddcc1f
Show file tree
Hide file tree
Showing 36 changed files with 104 additions and 593 deletions.
315 changes: 49 additions & 266 deletions apify-api/openapi/components/tags.yaml

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,7 @@ get:
in: query
description: |
The maximum number of seconds the server waits for the build to finish.
By default it is `0`, the maximum value is `60`.
<!-- MAX_ACTOR_JOB_ASYNC_WAIT_SECS -->
By default it is `0`, the maximum value is `60`. <!-- MAX_ACTOR_JOB_ASYNC_WAIT_SECS -->
If the build finishes in time then the returned build object will have a
terminal status (e.g. `SUCCEEDED`), otherwise it will have a transitional status (e.g. `RUNNING`).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,11 +44,11 @@ get:
text/plain:
schema:
type: string
example: |-
example: |
2017-07-14T06:00:49.733Z Application started.
2017-07-14T06:00:49.741Z Input: { test: 123 }
2017-07-14T06:00:49.752Z Some useful debug information follows.
example: |-
example: |
2017-07-14T06:00:49.733Z Application started.
2017-07-14T06:00:49.741Z Input: { test: 123 }
2017-07-14T06:00:49.752Z Some useful debug information follows.
Expand Down
8 changes: 2 additions & 6 deletions apify-api/openapi/paths/actor-runs/actor-runs@{runId}.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@ get:
* `/v2/actor-runs/{runId}/dataset{?token}`
* `/v2/actor-runs/{runId}/request-queue{?token}`
These API endpoints have the same usage as the equivalent storage endpoints.
For example, `/v2/actor-runs/{runId}/key-value-store` has the same HTTP method and
Expand Down Expand Up @@ -66,11 +65,8 @@ get:
payload to the same URL.Gets an object that contains all the details about a
specific run of an Actor.
By passing the optional `waitForFinish` parameter the API endpoint will
synchronously wait for the run to finish.
This is useful to avoid periodic polling when waiting for Actor run to
complete.
By passing the optional `waitForFinish` parameter the API endpoint will synchronously wait
for the run to finish. This is useful to avoid periodic polling when waiting for Actor run to complete.
This endpoint does not require the authentication token. Instead, calls are authenticated using a hard-to-guess ID of the run. However,
if you access the endpoint without the token, certain attributes, such as `usageUsd` and `usageTotalUsd`, will be hidden.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ post:
example: 3KH8gEpp4d8uQSe8T
- name: gracefully
in: query
description: |-
description: |
If true passed, the Actor run will abort gracefully.
It will send `aborting` and `persistState` event into run and force-stop the run after 30 seconds.
It is helpful in cases where you plan to resurrect the run later.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,6 @@ put:
The response is the full task input as returned by the
[Get task input](#/reference/tasks/task-input-object/get-task-input) endpoint.
The request needs to specify the `Content-Type: application/json` HTTP
header!
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -97,10 +97,8 @@ post:
description: |
Specifies optional webhooks associated with the Actor run, which can be
used to receive a notification
e.g. when the Actor finished or failed. The value is a Base64-encoded
JSON array of objects defining the webhooks. For more information, see
[Webhooks
documentation](https://docs.apify.com/platform/integrations/webhooks).
style: form
Expand All @@ -123,12 +121,9 @@ post:
description: |
If `true` or `1` then the API endpoint returns only non-empty items and
skips hidden fields
(i.e. fields starting with the # character).
The `clean` parameter is just a shortcut for `skipHidden=true` and
`skipEmpty=true` parameters.
Note that since some objects might be skipped from the output, that the
result might contain less items than the `limit` value.
style: form
Expand Down Expand Up @@ -160,12 +155,9 @@ post:
in: query
description: |
A comma-separated list of fields which should be picked from the items,
only these fields will remain in the resulting record objects.
Note that the fields in the outputted items are sorted the same way as
they are specified in the `fields` query parameter.
You can use this feature to effectively fix the output format.
style: form
explode: true
Expand All @@ -185,18 +177,13 @@ post:
description: |
A comma-separated list of fields which should be unwound, in order which
they should be processed. Each field should be either an array or an object.
If the field is an array then every element of
the array will become a separate record and merged with parent object.
If the unwound field is an object then it is merged with the parent
object
If the unwound field is missing or its value is neither an array nor an
object and therefore cannot be merged with a parent object then the item
gets preserved as it is.
Note that the unwound items ignore the `desc` parameter.
style: form
explode: true
Expand All @@ -208,10 +195,8 @@ post:
description: |
A comma-separated list of fields which should transform nested objects
into flat structures.
For example, with `flatten="foo"` the object `{"foo":{"bar": "hello"}}`
is turned into `{"foo.bar": "hello"}`.
The original object with properties is replaced with the flattened
object.
style: form
Expand Down Expand Up @@ -256,10 +241,8 @@ post:
description: |
All text responses are encoded in UTF-8 encoding. By default, the
`format=csv` files are prefixed with
the UTF-8 Byte Order Mark (BOM), while `json`, `jsonl`, `xml`, `html`
and `rss` files are not.
If you want to override this default behavior, specify `bom=1` query
parameter to include the BOM or `bom=0` to skip it.
style: form
Expand Down Expand Up @@ -297,7 +280,7 @@ post:
example: true
- name: skipHidden
in: query
description: |-
description: |
If `true` or `1` then hidden fields are skipped from the output,
i.e. fields starting with the `#` character.
style: form
Expand Down Expand Up @@ -687,7 +670,7 @@ get:
example: true
- name: skipHidden
in: query
description: |-
description: |
If `true` or `1` then hidden fields are skipped from the output,
i.e. fields starting with the `#` character.
style: form
Expand All @@ -712,10 +695,8 @@ get:
description: |
If `true` or `1` then, the endpoint applies the
`fields=url,pageFunctionResult,errorInfo`
and `unwind=pageFunctionResult` query parameters. This feature is used
to emulate simplified results provided by the
legacy Apify Crawler product and it's not recommended to use it in new
integrations.
style: form
Expand All @@ -728,7 +709,6 @@ get:
description: |
If `true` or `1` then, the all the items with errorInfo property will be
skipped from the output.
This feature is here to emulate functionality of API version 1 used for
the legacy Apify Crawler product and it's not recommended to use it in
new integrations.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ post:
example: 0.1.234
- name: outputRecordKey
in: query
description: |-
description: |
Key of the record from run's default key-value store to be returned
in the response. By default, it is `OUTPUT`.
style: form
Expand Down Expand Up @@ -227,7 +227,7 @@ get:
example: 0.1.234
- name: outputRecordKey
in: query
description: |-
description: |
Key of the record from run's default key-value store to be returned
in the response. By default, it is `OUTPUT`.
style: form
Expand All @@ -240,12 +240,9 @@ get:
description: |
Specifies optional webhooks associated with the Actor run, which can be
used to receive a notification
e.g. when the Actor finished or failed. The value is a Base64-encoded
JSON array of objects defining the webhooks. For more information, see
[Webhooks
documentation](https://docs.apify.com/platform/integrations/webhooks).
[Webhooks documentation](https://docs.apify.com/platform/integrations/webhooks).
style: form
explode: true
schema:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ post:
To fetch the Actor run results that are typically stored in the default
dataset, you'll need to pass the ID received in the `defaultDatasetId` field
received in the response JSON to the
received in the response JSON to the
[Get items](#/reference/datasets/item-collection/get-items) API endpoint.
operationId: actorTask_runs_post
parameters:
Expand Down Expand Up @@ -216,12 +216,9 @@ post:
in: query
description: |
The maximum number of seconds the server waits for the run to finish. By
default, it is `0`, the maximum value is `60`. <!--
MAX_ACTOR_JOB_ASYNC_WAIT_SECS -->
default, it is `0`, the maximum value is `60`. <!-- MAX_ACTOR_JOB_ASYNC_WAIT_SECS -->
If the build finishes in time then the returned run object will have a
terminal status (e.g. `SUCCEEDED`),
otherwise it will have a transitional status (e.g. `RUNNING`).
style: form
explode: true
Expand All @@ -234,7 +231,6 @@ post:
description: |
Specifies optional webhooks associated with the Actor run, which can be
used to receive a notification
e.g. when the Actor finished or failed. The value is a Base64-encoded
JSON array of objects defining the webhooks.
Expand Down
6 changes: 0 additions & 6 deletions apify-api/openapi/paths/actors/acts.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -102,20 +102,14 @@ post:
description: |
Creates a new Actor with settings specified in an Actor object passed as
JSON in the POST payload.
The response is the full Actor object as returned by the
[Get Actor](#/reference/actors/actor-object/get-actor) endpoint.
The HTTP request must have the `Content-Type: application/json` HTTP header!
The Actor needs to define at least one version of the source code.
For more information, see [Version object](#/reference/actors/version-object).
If you want to make your Actor
[public](https://docs.apify.com/platform/actors/publishing) using `isPublic:
true`, you will need to provide the Actor's `title` and the `categories`
Expand Down
5 changes: 0 additions & 5 deletions apify-api/openapi/paths/actors/acts@{actorId}.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -99,23 +99,18 @@ put:
description: |
Updates settings of an Actor using values specified by an Actor object
passed as JSON in the POST payload.
If the object does not define a specific property, its value will not be
updated.
The response is the full Actor object as returned by the
[Get Actor](#/reference/actors/actor-object/get-actor) endpoint.
The request needs to specify the `Content-Type: application/json` HTTP header!
When providing your API authentication token, we recommend using the
request's `Authorization` header, rather than the URL. ([More
info](#/introduction/authentication)).
If you want to make your Actor
[public](https://docs.apify.com/platform/actors/publishing) using `isPublic:
true`, you will need to provide the Actor's `title` and the `categories`
Expand Down
7 changes: 2 additions & 5 deletions apify-api/openapi/paths/actors/acts@{actorId}@builds.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,9 @@ get:
Gets the list of builds of a specific Actor. The response is a JSON with the
list of objects, where each object contains basic information about a single build.
The endpoint supports pagination using the `limit` and `offset` parameters
and it will not return more than 1000 records.
By default, the records are sorted by the `startedAt` field in ascending order,
therefore you can use pagination to incrementally fetch all builds while new
ones are still being started. To sort the records in descending order, use
Expand Down Expand Up @@ -78,7 +76,7 @@ post:
tags:
- Actors/Build collection
summary: Build Actor
description: |-
description: |
Builds an Actor.
The response is the build object as returned by the
[Get build](#/reference/actors/build-object/get-build) endpoint.
Expand Down Expand Up @@ -135,8 +133,7 @@ post:
in: query
description: |
The maximum number of seconds the server waits for the build to finish.
By default it is `0`, the maximum value is `60`. <!--
MAX_ACTOR_JOB_ASYNC_WAIT_SECS -->
By default it is `0`, the maximum value is `60`. <!-- MAX_ACTOR_JOB_ASYNC_WAIT_SECS -->
If the build finishes in time then the returned build object will have a terminal status (e.g. `SUCCEEDED`),
otherwise it will have a transitional status (e.g. `RUNNING`).
style: form
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,9 @@ get:
description: |
By passing the optional `waitForFinish` parameter the API endpoint will
synchronously wait for the build to finish.
This is useful to avoid periodic polling when waiting for an Actor build to
finish.
This endpoint does not require the authentication token. Instead, calls are authenticated using a hard-to-guess ID of the build. However,
if you access the endpoint without the token, certain attributes, such as `usageUsd` and `usageTotalUsd`, will be hidden.
operationId: act_build_get
Expand Down Expand Up @@ -37,10 +35,9 @@ get:
in: query
description: |
The maximum number of seconds the server waits for the build to finish.
By default it is `0`, the maximum value is `60`. <!--
MAX_ACTOR_JOB_ASYNC_WAIT_SECS -->
If the build finishes in time then the returned build object will have a terminal status (e.g. `SUCCEEDED`),
otherwise it will have a transitional status (e.g. `RUNNING`).
By default it is `0`, the maximum value is `60`. <!-- MAX_ACTOR_JOB_ASYNC_WAIT_SECS -->
If the build finishes in time then the returned build object will have a terminal status (e.g. `SUCCEEDED`),
otherwise it will have a transitional status (e.g. `RUNNING`).
style: form
explode: true
schema:
Expand Down
Loading

0 comments on commit eddcc1f

Please sign in to comment.