Repository navigation
Conversation
Drop the parentheses and trailing period around "More info" links in the OpenAPI spec and platform docs, and point the API authentication links to the Get started page, since the old #/introduction/authentication anchor did not resolve on individual endpoint pages. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Y6QEzb6KwtQKFiG83nzg5J
Contributor
|
API behavior and specification alignment: Aligned. |
Contributor
|
✅ Preview for this PR (commit |
Contributor
|
API behavior and specification alignment: Aligned. |
Link text pointing to API reference pages now matches each endpoint's current summary (or endpoint group title), across the OpenAPI spec and platform/academy pages. Legacy #/reference/... and #tag/... anchors to endpoints are replaced with /api/v2/<page> paths, since those anchors only exist on the target page itself. AGENTS.md now states the rule. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Y6QEzb6KwtQKFiG83nzg5J
Contributor
|
API behavior and specification alignment: Aligned. |
AGENTS.md is the instructions file, so the CLAUDE.md symlink is no longer needed. References to CLAUDE.md now point to AGENTS.md. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Y6QEzb6KwtQKFiG83nzg5J
Contributor
|
API behavior and specification alignment: Aligned. Reviewed commit: e2bb5e4 |
Full endpoint summaries read badly in inline lists such as the request queue rate limits. AGENTS.md now allows shortening each link to the word that tells the endpoints apart when a sentence lists several of them, and those lists go back to the short form. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Y6QEzb6KwtQKFiG83nzg5J
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
The Claude Code setup incorrectly implies that starting a session automatically loads AGENTS.md.
1 open issue
What changed in this PR
Standardizes API and authentication links across OpenAPI sources, platform documentation, and Academy tutorials.
Changes:
- Replaces legacy anchors and generic link labels with current API page paths and titles.
- Corrects the synchronous task example URL and removes redundant links.
- Adds API-link conventions and updates contributor setup references.
| File | Description |
|---|---|
| sources/platform/storage/request_queue.md | Standardizes rate-limit endpoint labels. |
| sources/platform/storage/key_value_store/index.md | Standardizes storage endpoint labels. |
| sources/platform/storage/index.md | Links each storage deletion endpoint. |
| sources/platform/storage/dataset/multiple_datasets.mdx | Names the dataset export endpoint. |
| sources/platform/storage/dataset/index.md | Clarifies dataset endpoint references. |
| sources/platform/storage/dataset/dataset_schema.md | Names the export-format endpoint. |
| sources/platform/proxy/index.md | Removes duplicate session links. |
| sources/platform/integrations/programming/webhooks/events.md | Updates the Actor runs group label. |
| sources/platform/integrations/integrate-with-apify.md | Standardizes integration endpoint labels. |
| sources/platform/integrations/ai/x402.md | Replaces a legacy run link. |
| sources/platform/integrations/ai/skyfire.md | Updates run and storage links. |
| sources/platform/integrations/actors/index.md | Names the run-details endpoint. |
| sources/platform/get-started/agent-onboarding.md | Standardizes API action labels. |
| sources/platform/actors/running/tasks.md | Names task execution endpoints. |
| sources/platform/actors/running/schedules.md | Corrects authentication and schedule links. |
| sources/platform/actors/running/runs_and_builds.md | Standardizes Actor endpoint references. |
| sources/platform/actors/publishing/publish-task.mdx | Names task publishing endpoints. |
| sources/platform/actors/development/programming_interface/container_web_server.md | Clarifies the container URL reference. |
| sources/platform/actors/development/builds_and_runs/runs.md | Names the Actor execution endpoint. |
| sources/platform/account/collaboration/general-resource-access.md | Standardizes public-access endpoint labels. |
| sources/academy/tutorials/node_js/apify_free_google_serp_api.md | Corrects the synchronous task URL. |
| sources/academy/tutorials/api/using_apify_from_php.md | Standardizes tutorial API links. |
| sources/academy/tutorials/api/run_actor_and_retrieve_data_via_api.md | Standardizes run and storage references. |
| sources/academy/platform/getting_started/apify_client.md | Consolidates the Actor update reference. |
| sources/academy/platform/getting_started/apify_api.md | Names synchronous and update endpoints. |
| sources/academy/build-and-publish/how-to-build/running_a_web_server.md | Names the run-details endpoint. |
| CONTRIBUTING.md | Updates the documented instruction symlink. |
| apify-api/openapi/paths/webhooks/webhooks@{webhookId}.yaml | Updates webhook and authentication links. |
| apify-api/openapi/paths/store/store.yaml | Updates the Actor details link. |
| apify-api/openapi/paths/schedules/schedules@{scheduleId}.yaml | Updates schedule and authentication links. |
| apify-api/openapi/paths/schedules/schedules.yaml | Corrects the authentication link. |
| apify-api/openapi/paths/actors/acts@{actorId}@versions@{versionNumber}@env-vars.yaml | Updates the environment-variable endpoint link. |
| apify-api/openapi/paths/actors/acts@{actorId}@versions.yaml | Updates the version endpoint link. |
| apify-api/openapi/paths/actors/acts@{actorId}@runs@last.yaml | Standardizes last-run references. |
| apify-api/openapi/paths/actors/acts@{actorId}@runs.yaml | Updates run and output links. |
| apify-api/openapi/paths/actors/acts@{actorId}@run-sync.yaml | Updates asynchronous run links. |
| apify-api/openapi/paths/actors/acts@{actorId}@run-sync-get-dataset-items.yaml | Updates dataset and run links. |
| apify-api/openapi/paths/actors/acts@{actorId}@builds@{buildId}@openapi.json.yaml | Disambiguates build-schema endpoint links. |
| apify-api/openapi/paths/actors/acts@{actorId}@builds.yaml | Updates the build-details link. |
| apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@runs@last.yaml | Standardizes task last-run references. |
| apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@runs.yaml | Updates task run and output links. |
| apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@run-sync.yaml | Updates asynchronous task links. |
| apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@run-sync-get-dataset-items.yaml | Updates task and dataset links. |
| apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@input.yaml | Updates input and authentication links. |
| apify-api/openapi/paths/actor-runs/actor-runs@{runId}.yaml | Standardizes default-storage labels. |
| apify-api/openapi/paths/actor-builds/actor-builds@{buildId}@openapi.json.yaml | Disambiguates build-schema endpoint links. |
| apify-api/openapi/openapi.yaml | Standardizes introduction and rate-limit links. |
| apify-api/openapi/components/tags.yaml | Updates schedule and logs references. |
| apify-api/openapi/components/securitySchemes/httpBearer.yaml | Standardizes authentication link wording. |
| apify-api/openapi/components/parameters/requestQueueParameters.yaml | Updates the queue-head reference. |
| apify-api/openapi/components/objects/request-queues/request-queue.yaml | Updates the queue-details link. |
| apify-api/openapi/components/objects/key-value-stores/key-value-store.yaml | Updates the store-details link. |
| apify-api/openapi/components/objects/key-value-stores/key-value-store-records.yaml | Standardizes record-write references. |
| apify-api/openapi/components/objects/key-value-stores/key-value-store-record.yaml | Replaces legacy record-write anchors. |
| apify-api/openapi/components/objects/datasets/dataset.yaml | Standardizes dataset endpoint references. |
| apify-api/openapi/components/objects/actors/acts@{actorId}@versions@{versionNumber}put.yaml | Updates version and authentication links. |
| apify-api/openapi/components/objects/actors/acts@{actorId}@versions@{versionNumber}@env-vars@{envVarName}put.yaml | Updates environment-variable and authentication links. |
| apify-api/openapi/components/objects/actor-runs/reboot.yaml | Updates reboot endpoint links. |
| apify-api/openapi/components/objects/actor-runs/metamorph.yaml | Updates metamorph endpoint links. |
| apify-api/openapi/components/objects/actor-runs/abort.yaml | Updates abort endpoint links. |
| AGENTS.md | Defines API-link conventions. |
| .markdownlintignore | Removes the CLAUDE.md exclusion. |
| .claude/README.md | Revises project-instruction setup guidance. |
Review effort: Balanced
Links such as [Version object](#/reference/actors/version-object) pointed to anchors that only exist on endpoint group pages, so they led nowhere. Object mentions are now plain text, since each endpoint page shows the object schema, and the deprecated-namespace notes link to the Manage Actor runs and Manage Actor builds pages. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Y6QEzb6KwtQKFiG83nzg5J
jancurn
commented
Oct 20, 2026
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Y6QEzb6KwtQKFiG83nzg5J
jancurn
changed the title
jancurn
marked this pull request as ready for review
October 20, 2026 14:18
jancurn
requested review from
TC-MO,
fnesveda,
honzajavorek,
janbuchar,
marcel-rbro and
szaganek
as code owners
October 20, 2026 14:18
jancurn
removed request for
fnesveda,
honzajavorek,
janbuchar and
marcel-rbro
October 20, 2026 14:18
Contributor
|
For TW review I'll let @szaganek handle this since I'm out sick, she should take care of it tomorrow. |
Member
Author
|
Thanks @TC-MO, hope you'll feel better soon. It should be safe to merge, I reviewed all the change |
This branch has not been deployed
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
From JC: And one more PR for API docs, last one for a while I promise :) I reviewed all code changes
Links to API endpoints across the OpenAPI spec and platform/academy docs now use each endpoint's current summary as link text (and "(More info)." becomes "Learn more"), and the invalid
#/reference/...and#tag/...anchors, which only resolve on the target page itself, are replaced with/api/v2/<page>links or plain text.AGENTS.mdgains a rule for linking to API endpoints, and theCLAUDE.mdsymlink is removed because Claude Code now readsAGENTS.mddirectly.🤖 Generated with Claude Code
https://claude.ai/code/session_01Y6QEzb6KwtQKFiG83nzg5J