-
Notifications
You must be signed in to change notification settings - Fork 182
docs(openapi): Add undocumented log endpoints #2441
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
Pijukatel
wants to merge
3
commits into
master
Choose a base branch
from
add-undocumented-log-endpoints
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| 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" | ||
| 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" | ||
|
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" | ||
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
| 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 |
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -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": | ||
|
|
@@ -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}": | ||
|
|
@@ -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}": | ||
|
|
||
44 changes: 1 addition & 43 deletions
44
apify-api/openapi/paths/actor-builds/actor-builds@{buildId}@log.yaml
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
| 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" |
2 changes: 2 additions & 0 deletions
2
apify-api/openapi/paths/actor-runs/actor-runs@{runId}@log.yaml
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| get: | ||
| $ref: "../../components/objects/logs/log.yaml#/getByRunId" |
2 changes: 2 additions & 0 deletions
2
apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@runs@[email protected]
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| get: | ||
| $ref: "../../components/objects/logs/log.yaml#/getTaskLastRun" |
2 changes: 2 additions & 0 deletions
2
apify-api/openapi/paths/actors/acts@{actorId}@runs@[email protected]
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| get: | ||
| $ref: "../../components/objects/logs/log.yaml#/getLastRun" |
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
| 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" |
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.