Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
121 changes: 121 additions & 0 deletions apify-api/openapi/components/objects/logs/log.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,121 @@
sharedGet: &sharedGet
responses:
"400":
$ref: ../../responses/BadRequest.yaml
"401":
$ref: ../../responses/Unauthorized.yaml
"403":
$ref: ../../responses/Forbidden.yaml
"404":
$ref: ../../responses/NotFound.yaml
"405":
$ref: ../../responses/MethodNotAllowed.yaml
"429":
$ref: ../../responses/TooManyRequests.yaml
"200":
description: ""
headers: {}
content:
text/plain:
schema:
type: string
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.
deprecated: false

getById:
<<: *sharedGet
tags:
- Logs
summary: Get log
x-legacy-doc-urls:
- https://docs.apify.com/api/v2#/reference/logs/log/get-log
- https://docs.apify.com/api/v2#/reference/logs/get-log
- https://docs.apify.com/api/v2#tag/LogsLog/operation/log_get
description: |
Retrieves logs for a specific Actor build or run.
operationId: log_get
parameters:
- $ref: "../../parameters/logParameters.yaml#/buildOrRunId"
- $ref: "../../parameters/logParameters.yaml#/stream"
- $ref: "../../parameters/logParameters.yaml#/download"
- $ref: "../../parameters/logParameters.yaml#/raw"
Comment thread
Pijukatel marked this conversation as resolved.
security:
- httpBearer: []
- apiKey: []
- {}
x-js-parent: LogClient
x-js-name: stream
x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/LogClient#stream
x-py-parent: LogClientAsync
x-py-name: stream
x-py-doc-url: https://docs.apify.com/api/client/python/reference/class/LogClientAsync#stream

getByRunId:
<<: *sharedGet
tags:
- Actor runs
summary: Get run's log
description: |
Retrieves Actor run's logs.

This endpoint is a shortcut for getting the run's log. Same as [Get log](/api/v2/log-get) endpoint.
operationId: actorRun_log_get
parameters:
- $ref: "../../parameters/runAndBuildParameters.yaml#/runId"
- $ref: "../../parameters/logParameters.yaml#/stream"
- $ref: "../../parameters/logParameters.yaml#/download"
- $ref: "../../parameters/logParameters.yaml#/raw"

getByBuildId:
<<: *sharedGet
tags:
- Actor builds
summary: Get build's Log
description: |
Retrieves Actor build's logs.

This endpoint is a shortcut for getting the build's log. Same as [Get log](/api/v2/log-get) endpoint.
operationId: actorBuild_log_get
parameters:
- $ref: "../../parameters/runAndBuildParameters.yaml#/buildId"
- $ref: "../../parameters/logParameters.yaml#/stream"
- $ref: "../../parameters/logParameters.yaml#/download"
Comment thread
Pijukatel marked this conversation as resolved.
x-legacy-doc-urls:
- https://docs.apify.com/api/v2#/reference/actor-builds/build-log/get-log
- https://docs.apify.com/api/v2#/reference/actor-builds/get-log
- https://docs.apify.com/api/v2#tag/Actor-buildsBuild-log/operation/actorBuild_log_get

getLastRun:
<<: *sharedGet
tags:
- Last Actor run's log
summary: Get last Actor run's log
description: |
Retrieves last Actor run's logs.

This endpoint is a shortcut for getting last Actor run's log. Same as [Get log](/api/v2/log-get) endpoint.
operationId: act_runs_last_log_get
parameters:
- $ref: "../../parameters/runAndBuildParameters.yaml#/actorId"
- $ref: "../../parameters/logParameters.yaml#/stream"
- $ref: "../../parameters/logParameters.yaml#/download"
- $ref: "../../parameters/logParameters.yaml#/raw"

getTaskLastRun:
<<: *sharedGet
tags:
- Last Actor task run's log
summary: Get last Actor task run's log
description: |
Retrieves last Actor task run's logs.

This endpoint is a shortcut for getting last Actor task run's log. Same as [Get log](/api/v2/log-get) endpoint.
operationId: actorTask_last_log_get
parameters:
- $ref: "../../parameters/runAndBuildParameters.yaml#/actorTaskId"
- $ref: "../../parameters/logParameters.yaml#/stream"
- $ref: "../../parameters/logParameters.yaml#/download"
- $ref: "../../parameters/logParameters.yaml#/raw"
51 changes: 51 additions & 0 deletions apify-api/openapi/components/objects/tools/tool.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
shared: &shared
tags:
- Tools
summary: Get browser info
description: |
Returns information about the HTTP request, including the client IP address,
country code, request headers, and body length.

This endpoint is designed for proxy testing. It accepts any HTTP method so you
can verify that your proxy correctly forwards requests of any type and that
client IP addresses are anonymized.
security: []
parameters:
- name: skipHeaders
in: query
description: If `true` or `1`, the response omits the `headers` field.
schema:
type: boolean
- name: rawHeaders
in: query
description: If `true` or `1`, the response includes the `rawHeaders` field with the raw request headers.
schema:
type: boolean
responses:
"200":
description: ""
content:
application/json:
schema:
$ref: ../../schemas/tools/BrowserInfoResponse.yaml
"405":
$ref: ../../responses/MethodNotAllowed.yaml
"429":
$ref: ../../responses/TooManyRequests.yaml
deprecated: false

get:
<<: *shared
operationId: tools_browser_info_get

post:
<<: *shared
operationId: tools_browser_info_post

put:
<<: *shared
operationId: tools_browser_info_put

delete:
<<: *shared
operationId: tools_browser_info_delete
Original file line number Diff line number Diff line change
Expand Up @@ -21,3 +21,26 @@ download:
schema:
type: boolean
example: false

buildOrRunId:
name: buildOrRunId
in: path
description: ID of the Actor build or run.
required: true
style: simple
schema:
type: string
example: HG7ML7M8z78YcAPE

raw:
name: raw
in: query
description: |
If `true` or `1`, the logs will be kept verbatim. By default, the API removes
ANSI escape codes from the logs, keeping only printable characters.
required: false
style: form
explode: true
schema:
type: boolean
example: false
12 changes: 12 additions & 0 deletions apify-api/openapi/components/tags.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -463,3 +463,15 @@
The API endpoints described in this section are convenience endpoints that provide access to Actor's last run's default request queue without the need to resolve the request queue ID first.

Subset of functionality described in: [Request queues](/api/v2/storage-request-queues)
- name: Last Actor run's log
x-displayName: Last Actor run's log - Introduction
description: |
The API endpoint described in this section is convenience endpoint that provides access to last Actor run's log.

Same as of functionality described in: [Logs](/api/v2/logs)
- name: Last Actor task run's log
x-displayName: Last Actor task run's log - Introduction
description: |
The API endpoint described in this section is convenience endpoint that provides access to last Actor task run's log.

Same as of functionality described in: [Logs](/api/v2/logs)
2 changes: 2 additions & 0 deletions apify-api/openapi/components/x-tag-groups.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -49,3 +49,5 @@
- Last Actor run's default dataset
- Last Actor run's default key-value store
- Last Actor run's default request queue
- Last Actor run's log
- Last Actor task run's log
6 changes: 6 additions & 0 deletions apify-api/openapi/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -544,6 +544,8 @@ paths:
$ref: "paths/actors/acts@{actorId}@runs@last@[email protected]"
"/v2/acts/{actorId}/runs/last/request-queue/head/lock":
$ref: "paths/actors/acts@{actorId}@runs@last@request-queue@[email protected]"
"/v2/acts/{actorId}/runs/last/log":
$ref: "paths/actors/acts@{actorId}@runs@[email protected]"
"/v2/acts/{actorId}/runs/{runId}":
$ref: "paths/actors/acts@{actorId}@runs@{runId}.yaml"
"/v2/acts/{actorId}/runs/{runId}/abort":
Expand All @@ -566,6 +568,8 @@ paths:
$ref: "paths/actor-tasks/actor-tasks@{actorTaskId}@run-sync-get-dataset-items.yaml"
"/v2/actor-tasks/{actorTaskId}/runs/last":
$ref: "paths/actor-tasks/actor-tasks@{actorTaskId}@[email protected]"
"/v2/actor-tasks/{actorTaskId}/runs/last/log":
$ref: "paths/actor-tasks/actor-tasks@{actorTaskId}@runs@[email protected]"
/v2/actor-runs:
$ref: paths/actor-runs/actor-runs.yaml
"/v2/actor-runs/{runId}":
Expand Down Expand Up @@ -610,6 +614,8 @@ paths:
$ref: "paths/actor-runs/actor-runs@{runId}@[email protected]"
"/v2/actor-runs/{runId}/request-queue/head/lock":
$ref: "paths/actor-runs/actor-runs@{runId}@request-queue@[email protected]"
"/v2/actor-runs/{runId}/log":
$ref: "paths/actor-runs/actor-runs@{runId}@log.yaml"
/v2/actor-builds:
$ref: paths/actor-builds/actor-builds.yaml
"/v2/actor-builds/{buildId}":
Expand Down
Original file line number Diff line number Diff line change
@@ -1,44 +1,2 @@
get:
tags:
- Actor builds
summary: Get log
# TODO: Fix description once /logs is cleaned up as well
description: "Check out [Logs](#/reference/logs) for full reference."
operationId: actorBuild_log_get
parameters:
- $ref: "../../components/parameters/runAndBuildParameters.yaml#/buildId"
- $ref: "../../components/parameters/logOptions.yaml#/stream"
- $ref: "../../components/parameters/logOptions.yaml#/download"
responses:
"200":
description: ""
headers: {}
content:
text/plain:
schema:
type: string
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: |
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.
"400":
$ref: ../../components/responses/BadRequest.yaml
"401":
$ref: ../../components/responses/Unauthorized.yaml
"403":
$ref: ../../components/responses/Forbidden.yaml
"404":
$ref: ../../components/responses/NotFound.yaml
"405":
$ref: ../../components/responses/MethodNotAllowed.yaml
"429":
$ref: ../../components/responses/TooManyRequests.yaml
deprecated: false
x-legacy-doc-urls:
- https://docs.apify.com/api/v2#/reference/actor-builds/build-log/get-log
- https://docs.apify.com/api/v2#/reference/actor-builds/get-log
- https://docs.apify.com/api/v2#tag/Actor-buildsBuild-log/operation/actorBuild_log_get
$ref: "../../components/objects/logs/log.yaml#/getByBuildId"
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
get:
$ref: "../../components/objects/logs/log.yaml#/getByRunId"
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
get:
$ref: "../../components/objects/logs/log.yaml#/getTaskLastRun"
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
get:
$ref: "../../components/objects/logs/log.yaml#/getLastRun"
68 changes: 1 addition & 67 deletions apify-api/openapi/paths/logs/logs@{buildOrRunId}.yaml
Original file line number Diff line number Diff line change
@@ -1,68 +1,2 @@
get:
tags:
- Logs
summary: Get log
x-legacy-doc-urls:
- https://docs.apify.com/api/v2#/reference/logs/log/get-log
- https://docs.apify.com/api/v2#/reference/logs/get-log
- https://docs.apify.com/api/v2#tag/LogsLog/operation/log_get
description: |
Retrieves logs for a specific Actor build or run.
operationId: log_get
parameters:
- name: buildOrRunId
in: path
description: ID of the Actor build or run.
required: true
style: simple
schema:
type: string
example: HG7ML7M8z78YcAPEB
- $ref: "../../components/parameters/logOptions.yaml#/stream"
- $ref: "../../components/parameters/logOptions.yaml#/download"
- name: raw
in: query
description: |
If `true` or `1`, the logs will be kept verbatim. By default, the API removes
ANSI escape codes from the logs, keeping only printable characters.
required: false
style: form
explode: true
schema:
type: boolean
example: false
responses:
"200":
description: ""
headers: {}
content:
text/plain:
schema:
type: string
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: |
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.
"400":
$ref: ../../components/responses/BadRequest.yaml
"401":
$ref: ../../components/responses/Unauthorized.yaml
"403":
$ref: ../../components/responses/Forbidden.yaml
"404":
$ref: ../../components/responses/NotFound.yaml
"405":
$ref: ../../components/responses/MethodNotAllowed.yaml
"429":
$ref: ../../components/responses/TooManyRequests.yaml
deprecated: false
x-js-parent: LogClient
x-js-name: stream
x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/LogClient#stream
x-py-parent: LogClientAsync
x-py-name: stream
x-py-doc-url: https://docs.apify.com/api/client/python/reference/class/LogClientAsync#stream
$ref: "../../components/objects/logs/log.yaml#/getById"
Loading