From 810ae7a732492933ba9f2e5e3fad7a748d5c5544 Mon Sep 17 00:00:00 2001 From: Claude Date: Thu, 30 Apr 2026 13:39:29 +0000 Subject: [PATCH 1/4] docs: improve API docs endpoint naming and remove redundant Introduction suffixes - Rename "Run Actor synchronously with input and get dataset items" to "Run Actor synchronously and get dataset items" - Rename "Run Actor synchronously with input and return output" to "Run Actor synchronously and return output" - Rename "Without input" to "Run Actor synchronously without input" - Remove "- Introduction" suffix from all tag display names https://claude.ai/code/session_01FiuLv5wqNDLtKCU4jSJpdo --- apify-api/openapi/components/tags.yaml | 62 +++++++++---------- ...@{actorId}@run-sync-get-dataset-items.yaml | 2 +- .../paths/actors/acts@{actorId}@run-sync.yaml | 4 +- 3 files changed, 34 insertions(+), 34 deletions(-) diff --git a/apify-api/openapi/components/tags.yaml b/apify-api/openapi/components/tags.yaml index 44d3c3e109..151c499af4 100644 --- a/apify-api/openapi/components/tags.yaml +++ b/apify-api/openapi/components/tags.yaml @@ -1,5 +1,5 @@ - name: Actors - x-displayName: Actors - Introduction + x-displayName: Actors x-legacy-doc-urls: - "#/reference/actors" - "#tag/Actors" @@ -15,7 +15,7 @@ - A tilde-separated combination of the Actor owner's username and the Actor name (e.g., `janedoe~my-actor`). - name: Actors/Actor versions - x-displayName: Actor versions - Introduction + x-displayName: Actor versions x-parent-tag-name: Actors x-legacy-doc-urls: - "#/reference/actors/version-collection" @@ -44,7 +44,7 @@ For more information about source code and Actor versions, check out [Source code](https://docs.apify.com/platform/actors/development/actor-definition/source-code) in Actors documentation. - name: Actors/Actor builds - x-displayName: Actor builds - Introduction + x-displayName: Actor builds x-parent-tag-name: Actors x-legacy-doc-urls: - "#/reference/actors/build-collection" @@ -56,7 +56,7 @@ description: | The API endpoints in this section allow you to manage your Apify Actors builds. - name: Actors/Actor runs - x-displayName: Actor runs - Introduction + x-displayName: Actor runs x-parent-tag-name: Actors x-legacy-doc-urls: - "#/reference/actors/run-collection" @@ -80,7 +80,7 @@ For more information about platform usage and resource calculations, see the [Usage and Resources documentation](https://docs.apify.com/platform/actors/running/usage-and-resources#usage). x-trait: "true" - name: Actors/Webhook collection - x-displayName: Webhook collection - Introduction + x-displayName: Webhook collection x-parent-tag-name: Actors x-legacy-doc-urls: - "#/reference/actors/webhook-collection" @@ -89,7 +89,7 @@ The API endpoint in this section allows you to get a list of webhooks of a specific Actor. x-trait: "true" - name: Actor builds - x-displayName: Actor builds - Introduction + x-displayName: Actor builds x-legacy-doc-urls: - "#/reference/actor-builds" - "#tag/Actor-builds" @@ -110,7 +110,7 @@ You can learn more about platform usage in the [documentation](https://docs.apify.com/platform/actors/running/usage-and-resources#usage). - name: Actor runs - x-displayName: Actor runs - Introduction + x-displayName: Actor runs x-legacy-doc-urls: - "#/reference/actor-runs" - "#tag/Actor-runs" @@ -126,7 +126,7 @@ You can learn more about platform usage in the [documentation](https://docs.apify.com/platform/actors/running/usage-and-resources#usage). - name: Actor tasks - x-displayName: Actor tasks - Introduction + x-displayName: Actor tasks x-legacy-doc-urls: - "#/reference/actor-tasks" - "#tag/Actor-tasks" @@ -168,7 +168,7 @@ x-displayName: "" description: Storage-related API endpoints for managing datasets, key-value stores, and request queues. - name: Storage/Datasets - x-displayName: Datasets - Introduction + x-displayName: Datasets x-parent-tag-name: Storage x-legacy-doc-urls: - "#/reference/datasets" @@ -198,7 +198,7 @@ ::: x-trait: "true" - name: Storage/Key-value stores - x-displayName: Key-value stores - Introduction + x-displayName: Key-value stores x-parent-tag-name: Storage x-legacy-doc-urls: - "#/reference/key-value-stores/key-collection" @@ -228,7 +228,7 @@ ::: x-trait: "true" - name: Storage/Request queues - x-displayName: Request queues - Introduction + x-displayName: Request queues x-parent-tag-name: Storage x-legacy-doc-urls: - "#/reference/request-queues" @@ -256,7 +256,7 @@ ::: - name: Storage/Request queues/Requests - x-displayName: Requests - Introduction + x-displayName: Requests x-parent-tag-name: Storage x-legacy-doc-urls: - "#/reference/request-queues/request-collection" @@ -280,7 +280,7 @@ ::: - name: Storage/Request queues/Requests locks - x-displayName: Requests locks - Introduction + x-displayName: Requests locks x-parent-tag-name: Storage x-legacy-doc-urls: @@ -310,7 +310,7 @@ x-displayName: "" description: Webhook-related API endpoints for configuring automated notifications. - name: Webhooks/Webhooks - x-displayName: Webhooks - Introduction + x-displayName: Webhooks x-parent-tag-name: Webhooks x-legacy-doc-urls: - "#/reference/webhooks" @@ -334,7 +334,7 @@ For more information see [Webhooks documentation](https://docs.apify.com/platform/integrations/webhooks). - name: Webhooks/Webhook dispatches - x-displayName: Webhook dispatches - Introduction + x-displayName: Webhook dispatches x-parent-tag-name: Webhooks x-legacy-doc-urls: - "#/reference/webhook-dispatches" @@ -345,7 +345,7 @@ - "#tag/Webhook-dispatchesWebhook-dispatch-object" description: This section describes API endpoints to get webhook dispatches. - name: Schedules - x-displayName: Schedules - Introduction + x-displayName: Schedules x-legacy-doc-urls: - "#/reference/schedules" - "#tag/Schedules" @@ -370,7 +370,7 @@ For details, see the documentation of the [Get schedule](#/reference/schedules/schedule-object/get-schedule) endpoint. x-trait: "true" - name: Store - x-displayName: Store - Introduction + x-displayName: Store x-legacy-doc-urls: - "#/reference/store" - "#tag/Store" @@ -388,7 +388,7 @@ ::: x-trait: true - name: Logs - x-displayName: Logs - Introduction + x-displayName: Logs x-legacy-doc-urls: - "#/reference/logs" - "#tag/Logs" @@ -407,7 +407,7 @@ ::: x-trait: true - name: Users - x-displayName: Users - Introduction + x-displayName: Users x-legacy-doc-urls: - "#/reference/users" - "#tag/Users" @@ -423,72 +423,72 @@ user accounts. x-trait: true - name: Tools - x-displayName: Tools - Introduction + x-displayName: Tools description: | The API endpoints described in this section provide utility tools for encoding, signing, and verifying data, as well as inspecting HTTP request details. - name: Default dataset - x-displayName: Default dataset - Introduction + x-displayName: Default dataset description: | The API endpoints described in this section are convenience endpoints that provide access to Actor run's default dataset without the need to resolve the dataset ID first. Subset of functionality described in: [Datasets](/api/v2/storage-datasets) - name: Default key-value store - x-displayName: Default key-value store - Introduction + x-displayName: Default key-value store description: | The API endpoints described in this section are convenience endpoints that provide access to Actor run's default key-value store without the need to resolve the key-value store ID first. Subset of functionality described in: [Key-value stores](/api/v2/storage-key-value-stores) - name: Default request queue - x-displayName: Default request queue - Introduction + x-displayName: Default request queue description: | The API endpoints described in this section are convenience endpoints that provide access to Actor 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 default dataset - x-displayName: Last Actor run's default dataset - Introduction + x-displayName: Last Actor run's default dataset description: | The API endpoints described in this section are convenience endpoints that provide access to Actor's last run's default dataset without the need to resolve the dataset ID first. Subset of functionality described in: [Datasets](/api/v2/storage-datasets) - name: Last Actor run's default key-value store - x-displayName: Last Actor run's default key-value store - Introduction + x-displayName: Last Actor run's default key-value store description: | The API endpoints described in this section are convenience endpoints that provide access to Actor's last run's default key-value store without the need to resolve the key-value store ID first. Subset of functionality described in: [Key-value stores](/api/v2/storage-key-value-stores) - name: Last Actor run's default request queue - x-displayName: Last Actor run's default request queue - Introduction + x-displayName: Last Actor run's default request queue description: | 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 + x-displayName: Last Actor run's log 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 + x-displayName: Last Actor task run's log 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) - name: Last Actor task run's default dataset - x-displayName: Last Actor task run's default dataset - Introduction + x-displayName: Last Actor task run's default dataset description: | The API endpoints described in this section are convenience endpoints that provide access to Actor task's last run's default dataset without the need to resolve the dataset ID first. Subset of functionality described in: [Datasets](/api/v2/storage-datasets) - name: Last Actor task run's default key-value store - x-displayName: Last Actor task run's default key-value store - Introduction + x-displayName: Last Actor task run's default key-value store description: | The API endpoints described in this section are convenience endpoints that provide access to Actor task's last run's default key-value store without the need to resolve the key-value store ID first. Subset of functionality described in: [Key-value stores](/api/v2/storage-key-value-stores) - name: Last Actor task run's default request queue - x-displayName: Last Actor task run's default request queue - Introduction + x-displayName: Last Actor task run's default request queue description: | The API endpoints described in this section are convenience endpoints that provide access to Actor task's last run's default request queue without the need to resolve the request queue ID first. diff --git a/apify-api/openapi/paths/actors/acts@{actorId}@run-sync-get-dataset-items.yaml b/apify-api/openapi/paths/actors/acts@{actorId}@run-sync-get-dataset-items.yaml index 572afab0d8..47b246e0b0 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}@run-sync-get-dataset-items.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}@run-sync-get-dataset-items.yaml @@ -1,7 +1,7 @@ post: tags: - Actors/Actor runs - summary: Run Actor synchronously with input and get dataset items + summary: Run Actor synchronously and get dataset items description: | Runs a specific Actor and returns its dataset items. diff --git a/apify-api/openapi/paths/actors/acts@{actorId}@run-sync.yaml b/apify-api/openapi/paths/actors/acts@{actorId}@run-sync.yaml index f102528829..c98921d222 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}@run-sync.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}@run-sync.yaml @@ -1,7 +1,7 @@ post: tags: - Actors/Actor runs - summary: Run Actor synchronously with input and return output + summary: Run Actor synchronously and return output description: | Runs a specific Actor and returns its output. @@ -85,7 +85,7 @@ post: get: tags: - Actors/Actor runs - summary: Without input + summary: Run Actor synchronously without input description: | Runs a specific Actor and returns its output. The run must finish in 300 seconds From 179e71d9dcdf817ac0aa866a1bf08d12e6827cc4 Mon Sep 17 00:00:00 2001 From: Claude Date: Tue, 5 May 2026 07:07:10 +0000 Subject: [PATCH 2/4] revert: keep Introduction suffix in tag display names Per reviewer feedback - removing the suffix causes duplicate labels in sidebar (group label and index page render as identical siblings). The endpoint summary improvements are kept. https://claude.ai/code/session_01FiuLv5wqNDLtKCU4jSJpdo --- apify-api/openapi/components/tags.yaml | 62 +++++++++++++------------- 1 file changed, 31 insertions(+), 31 deletions(-) diff --git a/apify-api/openapi/components/tags.yaml b/apify-api/openapi/components/tags.yaml index 151c499af4..44d3c3e109 100644 --- a/apify-api/openapi/components/tags.yaml +++ b/apify-api/openapi/components/tags.yaml @@ -1,5 +1,5 @@ - name: Actors - x-displayName: Actors + x-displayName: Actors - Introduction x-legacy-doc-urls: - "#/reference/actors" - "#tag/Actors" @@ -15,7 +15,7 @@ - A tilde-separated combination of the Actor owner's username and the Actor name (e.g., `janedoe~my-actor`). - name: Actors/Actor versions - x-displayName: Actor versions + x-displayName: Actor versions - Introduction x-parent-tag-name: Actors x-legacy-doc-urls: - "#/reference/actors/version-collection" @@ -44,7 +44,7 @@ For more information about source code and Actor versions, check out [Source code](https://docs.apify.com/platform/actors/development/actor-definition/source-code) in Actors documentation. - name: Actors/Actor builds - x-displayName: Actor builds + x-displayName: Actor builds - Introduction x-parent-tag-name: Actors x-legacy-doc-urls: - "#/reference/actors/build-collection" @@ -56,7 +56,7 @@ description: | The API endpoints in this section allow you to manage your Apify Actors builds. - name: Actors/Actor runs - x-displayName: Actor runs + x-displayName: Actor runs - Introduction x-parent-tag-name: Actors x-legacy-doc-urls: - "#/reference/actors/run-collection" @@ -80,7 +80,7 @@ For more information about platform usage and resource calculations, see the [Usage and Resources documentation](https://docs.apify.com/platform/actors/running/usage-and-resources#usage). x-trait: "true" - name: Actors/Webhook collection - x-displayName: Webhook collection + x-displayName: Webhook collection - Introduction x-parent-tag-name: Actors x-legacy-doc-urls: - "#/reference/actors/webhook-collection" @@ -89,7 +89,7 @@ The API endpoint in this section allows you to get a list of webhooks of a specific Actor. x-trait: "true" - name: Actor builds - x-displayName: Actor builds + x-displayName: Actor builds - Introduction x-legacy-doc-urls: - "#/reference/actor-builds" - "#tag/Actor-builds" @@ -110,7 +110,7 @@ You can learn more about platform usage in the [documentation](https://docs.apify.com/platform/actors/running/usage-and-resources#usage). - name: Actor runs - x-displayName: Actor runs + x-displayName: Actor runs - Introduction x-legacy-doc-urls: - "#/reference/actor-runs" - "#tag/Actor-runs" @@ -126,7 +126,7 @@ You can learn more about platform usage in the [documentation](https://docs.apify.com/platform/actors/running/usage-and-resources#usage). - name: Actor tasks - x-displayName: Actor tasks + x-displayName: Actor tasks - Introduction x-legacy-doc-urls: - "#/reference/actor-tasks" - "#tag/Actor-tasks" @@ -168,7 +168,7 @@ x-displayName: "" description: Storage-related API endpoints for managing datasets, key-value stores, and request queues. - name: Storage/Datasets - x-displayName: Datasets + x-displayName: Datasets - Introduction x-parent-tag-name: Storage x-legacy-doc-urls: - "#/reference/datasets" @@ -198,7 +198,7 @@ ::: x-trait: "true" - name: Storage/Key-value stores - x-displayName: Key-value stores + x-displayName: Key-value stores - Introduction x-parent-tag-name: Storage x-legacy-doc-urls: - "#/reference/key-value-stores/key-collection" @@ -228,7 +228,7 @@ ::: x-trait: "true" - name: Storage/Request queues - x-displayName: Request queues + x-displayName: Request queues - Introduction x-parent-tag-name: Storage x-legacy-doc-urls: - "#/reference/request-queues" @@ -256,7 +256,7 @@ ::: - name: Storage/Request queues/Requests - x-displayName: Requests + x-displayName: Requests - Introduction x-parent-tag-name: Storage x-legacy-doc-urls: - "#/reference/request-queues/request-collection" @@ -280,7 +280,7 @@ ::: - name: Storage/Request queues/Requests locks - x-displayName: Requests locks + x-displayName: Requests locks - Introduction x-parent-tag-name: Storage x-legacy-doc-urls: @@ -310,7 +310,7 @@ x-displayName: "" description: Webhook-related API endpoints for configuring automated notifications. - name: Webhooks/Webhooks - x-displayName: Webhooks + x-displayName: Webhooks - Introduction x-parent-tag-name: Webhooks x-legacy-doc-urls: - "#/reference/webhooks" @@ -334,7 +334,7 @@ For more information see [Webhooks documentation](https://docs.apify.com/platform/integrations/webhooks). - name: Webhooks/Webhook dispatches - x-displayName: Webhook dispatches + x-displayName: Webhook dispatches - Introduction x-parent-tag-name: Webhooks x-legacy-doc-urls: - "#/reference/webhook-dispatches" @@ -345,7 +345,7 @@ - "#tag/Webhook-dispatchesWebhook-dispatch-object" description: This section describes API endpoints to get webhook dispatches. - name: Schedules - x-displayName: Schedules + x-displayName: Schedules - Introduction x-legacy-doc-urls: - "#/reference/schedules" - "#tag/Schedules" @@ -370,7 +370,7 @@ For details, see the documentation of the [Get schedule](#/reference/schedules/schedule-object/get-schedule) endpoint. x-trait: "true" - name: Store - x-displayName: Store + x-displayName: Store - Introduction x-legacy-doc-urls: - "#/reference/store" - "#tag/Store" @@ -388,7 +388,7 @@ ::: x-trait: true - name: Logs - x-displayName: Logs + x-displayName: Logs - Introduction x-legacy-doc-urls: - "#/reference/logs" - "#tag/Logs" @@ -407,7 +407,7 @@ ::: x-trait: true - name: Users - x-displayName: Users + x-displayName: Users - Introduction x-legacy-doc-urls: - "#/reference/users" - "#tag/Users" @@ -423,72 +423,72 @@ user accounts. x-trait: true - name: Tools - x-displayName: Tools + x-displayName: Tools - Introduction description: | The API endpoints described in this section provide utility tools for encoding, signing, and verifying data, as well as inspecting HTTP request details. - name: Default dataset - x-displayName: Default dataset + x-displayName: Default dataset - Introduction description: | The API endpoints described in this section are convenience endpoints that provide access to Actor run's default dataset without the need to resolve the dataset ID first. Subset of functionality described in: [Datasets](/api/v2/storage-datasets) - name: Default key-value store - x-displayName: Default key-value store + x-displayName: Default key-value store - Introduction description: | The API endpoints described in this section are convenience endpoints that provide access to Actor run's default key-value store without the need to resolve the key-value store ID first. Subset of functionality described in: [Key-value stores](/api/v2/storage-key-value-stores) - name: Default request queue - x-displayName: Default request queue + x-displayName: Default request queue - Introduction description: | The API endpoints described in this section are convenience endpoints that provide access to Actor 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 default dataset - x-displayName: Last Actor run's default dataset + x-displayName: Last Actor run's default dataset - Introduction description: | The API endpoints described in this section are convenience endpoints that provide access to Actor's last run's default dataset without the need to resolve the dataset ID first. Subset of functionality described in: [Datasets](/api/v2/storage-datasets) - name: Last Actor run's default key-value store - x-displayName: Last Actor run's default key-value store + x-displayName: Last Actor run's default key-value store - Introduction description: | The API endpoints described in this section are convenience endpoints that provide access to Actor's last run's default key-value store without the need to resolve the key-value store ID first. Subset of functionality described in: [Key-value stores](/api/v2/storage-key-value-stores) - name: Last Actor run's default request queue - x-displayName: Last Actor run's default request queue + x-displayName: Last Actor run's default request queue - Introduction description: | 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 + 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 + 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) - name: Last Actor task run's default dataset - x-displayName: Last Actor task run's default dataset + x-displayName: Last Actor task run's default dataset - Introduction description: | The API endpoints described in this section are convenience endpoints that provide access to Actor task's last run's default dataset without the need to resolve the dataset ID first. Subset of functionality described in: [Datasets](/api/v2/storage-datasets) - name: Last Actor task run's default key-value store - x-displayName: Last Actor task run's default key-value store + x-displayName: Last Actor task run's default key-value store - Introduction description: | The API endpoints described in this section are convenience endpoints that provide access to Actor task's last run's default key-value store without the need to resolve the key-value store ID first. Subset of functionality described in: [Key-value stores](/api/v2/storage-key-value-stores) - name: Last Actor task run's default request queue - x-displayName: Last Actor task run's default request queue + x-displayName: Last Actor task run's default request queue - Introduction description: | The API endpoints described in this section are convenience endpoints that provide access to Actor task's last run's default request queue without the need to resolve the request queue ID first. From 39a3d5ca968faf8cafa1d98c4294873209ac7f83 Mon Sep 17 00:00:00 2001 From: Jan Curn Date: Wed, 6 May 2026 13:28:22 +0200 Subject: [PATCH 3/4] Better copy --- apify-api/openapi/openapi.yaml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/apify-api/openapi/openapi.yaml b/apify-api/openapi/openapi.yaml index 54e44f9e9b..46a785be70 100644 --- a/apify-api/openapi/openapi.yaml +++ b/apify-api/openapi/openapi.yaml @@ -37,9 +37,9 @@ info: ## Authentication - You can find your API token on the - [Integrations](https://console.apify.com/account#/integrations) page in the - Apify Console. + **You can find your API token on the + [Integrations](https://console.apify.com/settings/integrations) page in the + Apify Console.** To use your token in a request, either: @@ -54,7 +54,7 @@ info: in browser history and server logs. This creates a chance for someone unauthorized to access your API token. - **Do not share your API token or password with untrusted parties.** + **Never share your API token or password with untrusted parties!** For more information, see our [integrations](https://docs.apify.com/platform/integrations) documentation. From 8760545dbebec90b2a32d26bce4431370f79e16e Mon Sep 17 00:00:00 2001 From: Jan Curn Date: Thu, 7 May 2026 23:48:16 +0200 Subject: [PATCH 4/4] Better copy --- src/pages/index.tsx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/pages/index.tsx b/src/pages/index.tsx index ae9ae5a27f..9e983bed57 100644 --- a/src/pages/index.tsx +++ b/src/pages/index.tsx @@ -66,7 +66,7 @@ export default function Home() { align="center" description={ - Learn how to put the web to work with Apify. + Learn how to put the web to work. } />