docs(openapi): Add undocumented log endpoints#2441
Conversation
Refactor and reuse some arguments.
|
Preview for this PR was built for commit |
There was a problem hiding this comment.
Pull request overview
This PR extends the OpenAPI specification to cover previously undocumented (but public) log-related endpoints and reduces duplication by extracting shared OpenAPI operation fragments into reusable component objects.
Changes:
- Add OpenAPI paths for Actor run log, last Actor run log, and last Actor task run log.
- Refactor existing
/v2/logs/{buildOrRunId}and/v2/browser-infopath definitions to use shared$ref-based component objects. - Introduce reusable
logandtoolcomponent objects and consolidate log-related parameters.
Reviewed changes
Copilot reviewed 12 out of 12 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| apify-api/openapi/paths/tools/[email protected] | Replaces duplicated per-method definitions with $ref to a shared Tools operation object. |
| apify-api/openapi/components/objects/tools/tool.yaml | New shared operation object for /v2/browser-info methods. |
| apify-api/openapi/paths/logs/logs@{buildOrRunId}.yaml | Refactors /v2/logs/{buildOrRunId} to reference a shared Logs operation object. |
| apify-api/openapi/components/objects/logs/log.yaml | New shared operation object for log retrieval endpoints (by id/run/build/last run). |
| apify-api/openapi/components/parameters/logParameters.yaml | Adds reusable buildOrRunId path parameter and raw query parameter. |
| apify-api/openapi/paths/actors/acts@{actorId}@Runs@[email protected] | New convenience path for last Actor run log, referencing shared log operation. |
| apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@Runs@[email protected] | New convenience path for last Actor task run log, referencing shared log operation. |
| apify-api/openapi/paths/actor-runs/actor-runs@{runId}@log.yaml | New convenience path for Actor run log, referencing shared log operation. |
| apify-api/openapi/paths/actor-builds/actor-builds@{buildId}@log.yaml | Refactors build log path to reference shared log operation. |
| apify-api/openapi/openapi.yaml | Registers new log-related paths in the root OpenAPI paths map. |
| apify-api/openapi/components/x-tag-groups.yaml | Adds the new convenience log tags to the “Convenience endpoints” group. |
| apify-api/openapi/components/tags.yaml | Adds tag definitions/intros for the new convenience log endpoint sections. |
Comments suppressed due to low confidence (1)
apify-api/openapi/components/parameters/logParameters.yaml:33
buildOrRunIdparameter example looks truncated (HG7ML7M8z78YcAPE) compared to the commonly used ID example (HG7ML7M8z78YcAPEB) elsewhere in the OpenAPI spec. Consider updating the example to the standard value to keep examples consistent across the docs/spec.
eb34c34 to
eb7eb11
Compare
|
A PR to update the Python client models has been created: apify/apify-client-python#740 This was automatically triggered by OpenAPI specification changes in this PR. |
|
Preview for this PR was built for commit |
Description
(More undocumented endpoints will be added in follow-up PRs)
Issues
Partially implements: #2286