feat: add Redoc legacy urls and a script for traversing and safe dumping the yamls (#1372)

Co-authored-by: Martin Adámek <[email protected]>

Author: netmilk

apify-api/openapi/components/tags.yaml

@@ -5,6 +5,7 @@ get:
   x-legacy-doc-urls:
     - https://docs.apify.com/api/v2#/reference/actor-builds/build-collection/get-user-builds-list
     - https://docs.apify.com/api/v2#/reference/actor-builds/get-user-builds-list
+    - https://docs.apify.com/api/v2#tag/Actor-buildsBuild-collection/operation/actorBuilds_get
   description: |
     Gets a list of all builds for a user. The response is a JSON array of
     objects, where each object contains basic information about a single build.

apify-api/openapi/paths/actor-builds/actor-builds.yaml

@@ -54,6 +54,7 @@ get:
   x-legacy-doc-urls:
     - https://docs.apify.com/api/v2#/reference/actor-builds/build-object/get-build
     - https://docs.apify.com/api/v2#/reference/actor-builds/get-build
+    - https://docs.apify.com/api/v2#tag/Actor-buildsBuild-object/operation/actorBuild_get
   x-js-parent: BuildClient
   x-js-name: get
   x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/BuildClient#get
@@ -89,6 +90,7 @@ delete:
   x-legacy-doc-urls:
     - https://docs.apify.com/api/v2#/reference/actor-builds/delete-build/delete-build
     - https://docs.apify.com/api/v2#/reference/actor-builds/delete-build
+    - https://docs.apify.com/api/v2#tag/Actor-builds/operation/actorBuild_delete
   x-js-parent: BuildClient
   x-js-name: delete
   x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/BuildClient#delete

apify-api/openapi/paths/actor-builds/actor-builds@{buildId}.yaml

@@ -31,6 +31,7 @@ post:
   x-legacy-doc-urls:
     - https://docs.apify.com/api/v2#/reference/actor-builds/abort-build/abort-build
     - https://docs.apify.com/api/v2#/reference/actor-builds/abort-build
+    - https://docs.apify.com/api/v2#tag/Actor-buildsAbort-build/operation/actorBuild_abort_post
   x-js-parent: BuildClient
   x-js-name: abort
   x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/BuildClient#abort

apify-api/openapi/paths/actor-builds/actor-builds@{buildId}@abort.yaml

@@ -56,3 +56,4 @@ get:
   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

apify-api/openapi/paths/actor-builds/actor-builds@{buildId}@log.yaml

@@ -108,3 +108,4 @@ get:
   x-legacy-doc-urls:
     - https://docs.apify.com/api/v2#/reference/actor-runs/run-collection/get-user-runs-list
     - https://docs.apify.com/api/v2#/reference/actor-runs/get-user-runs-list
+    - https://docs.apify.com/api/v2#tag/Actor-runsRun-collection/operation/actorRuns_get

apify-api/openapi/paths/actor-runs/actor-runs.yaml

@@ -183,6 +183,7 @@ get:
   x-legacy-doc-urls:
     - https://docs.apify.com/api/v2#/reference/actor-runs/run-object-and-its-storages/get-run
     - https://docs.apify.com/api/v2#/reference/actor-runs/get-run
+    - https://docs.apify.com/api/v2#tag/Actor-runsRun-object-and-its-storages/operation/actorRun_get
 delete:
   tags:
     - Actor runs/Delete run
@@ -209,6 +210,7 @@ delete:
   x-legacy-doc-urls:
     - https://docs.apify.com/api/v2#/reference/actor-runs/delete-run/delete-run
     - https://docs.apify.com/api/v2#/reference/actor-runs/delete-run
+    - https://docs.apify.com/api/v2#tag/Actor-runsDelete-run/operation/actorRun_delete
   x-js-parent: RunClient
   x-js-name: delete
   x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/RunClient#delete
@@ -335,3 +337,4 @@ put:
   x-legacy-doc-urls:
     - https://docs.apify.com/api/v2#/reference/actor-runs/update-status-message/update-status-message
     - https://docs.apify.com/api/v2#/reference/actor-runs/update-status-message
+    - https://docs.apify.com/api/v2#tag/Actor-runsUpdate-status-message/operation/actorRun_put

apify-api/openapi/paths/actor-runs/actor-runs@{runId}.yaml

@@ -111,6 +111,7 @@ post:
   x-legacy-doc-urls:
     - https://docs.apify.com/api/v2#/reference/actor-runs/abort-run/abort-run
     - https://docs.apify.com/api/v2#/reference/actor-runs/abort-run
+    - https://docs.apify.com/api/v2#tag/Actor-runsAbort-run/operation/actorRun_abort_post
   x-js-parent: RunClient
   x-js-name: abort
   x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/RunClient#abort

apify-api/openapi/paths/actor-runs/actor-runs@{runId}@abort.yaml

@@ -25,15 +25,15 @@ post:
       example: 2024-12-09T01:23:45.000Z-random-uuid
       description: Always pass a unique idempotency key (any unique string) for each charge to avoid double charging in case of retries or network errors.
   requestBody:
-      description: 'Define which event, and how many times, you want to charge for.'
-      content:
-          application/json:
-              schema:
-                  $ref: "../../components/schemas/actor-runs/ChargeRunRequest.yaml"
-              example:
-                  eventName: 'ANALYZE_PAGE'
-                  eventCount: 1
-      required: true
+    description: 'Define which event, and how many times, you want to charge for.'
+    content:
+      application/json:
+        schema:
+          $ref: "../../components/schemas/actor-runs/ChargeRunRequest.yaml"
+        example:
+          eventName: 'ANALYZE_PAGE'
+          eventCount: 1
+    required: true
   responses:
     '201':
       description: 'The charge was successful. Note that you still have to make sure in your Actor that the total charge for the run respects the maximum value set by the user, as the API does not check this. Above the limit, the charges reported as successful in API will not be added to your payouts, but you will still bear the associated costs. Use the Apify charge manager or SDK to avoid having to deal with this manually.'
@@ -45,4 +45,5 @@ post:
   x-py-name: charge
   x-py-doc-url: https://docs.apify.com/api/client/python/reference/class/RunClientAsync#charge
   x-legacy-doc-urls:
-      - https://docs.apify.com/api/v2#/reference/actor-runs/charge-events-in-run
+    - https://docs.apify.com/api/v2#/reference/actor-runs/charge-events-in-run
+    - https://docs.apify.com/api/v2#tag/Actor-runsCharge-events-in-run/operation/PostChargeRun

apify-api/openapi/paths/actor-runs/actor-runs@{runId}@charge.yaml

@@ -139,6 +139,7 @@ post:
   x-legacy-doc-urls:
     - https://docs.apify.com/api/v2#/reference/actor-runs/metamorph-run/metamorph-run
     - https://docs.apify.com/api/v2#/reference/actor-runs/metamorph-run
+    - https://docs.apify.com/api/v2#tag/Actor-runsMetamorph-run/operation/actorRun_metamorph_post
   x-js-parent: RunClient
   x-js-name: metamorph
   x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/RunClient#metamorph