docs(openapi): Autofix OpenAPI spec validation errors

apify-api/openapi/components/tags.yaml

@@ -125,6 +125,30 @@
     has been used for computation of this dollar equivalent, and hence it should be used only for informative purposes.
 
     You can learn more about platform usage in the [documentation](https://docs.apify.com/platform/actors/running/usage-and-resources#usage).
+- name: Actor runs/Dataset
+  x-displayName: Default dataset
+  x-parent-tag-name: Actor runs
+  x-trait: "true"
+  description: |
+    These endpoints provide shortcuts to access the default dataset of an Actor run.
+    They resolve the run's `defaultDatasetId` and proxy requests to the corresponding
+    [Datasets](/api/v2/datasets) endpoints.
+- name: Actor runs/Key-value store
+  x-displayName: Default key-value store
+  x-parent-tag-name: Actor runs
+  x-trait: "true"
+  description: |
+    These endpoints provide shortcuts to access the default key-value store of an Actor run.
+    They resolve the run's `defaultKeyValueStoreId` and proxy requests to the corresponding
+    [Key-value stores](/api/v2/key-value-stores) endpoints.
+- name: Actor runs/Request queue
+  x-displayName: Default request queue
+  x-parent-tag-name: Actor runs
+  x-trait: "true"
+  description: |
+    These endpoints provide shortcuts to access the default request queue of an Actor run.
+    They resolve the run's `defaultRequestQueueId` and proxy requests to the corresponding
+    [Request queues](/api/v2/request-queues) endpoints.
 - name: Actor tasks
   x-displayName: Actor tasks - Introduction
   x-legacy-doc-urls:

apify-api/openapi/openapi.yaml

@@ -520,6 +520,8 @@ paths:
     $ref: "paths/actors/acts@{actorId}@runs@{runId}@abort.yaml"
   "/v2/acts/{actorId}/runs/{runId}/metamorph":
     $ref: "paths/actors/acts@{actorId}@runs@{runId}@metamorph.yaml"
+  "/v2/acts/{actorId}/validate-input":
+    $ref: "paths/actors/acts@{actorId}@validate-input.yaml"
   /v2/actor-tasks:
     $ref: paths/actor-tasks/actor-tasks.yaml
   "/v2/actor-tasks/{actorTaskId}":
@@ -550,6 +552,38 @@ paths:
     $ref: paths/actor-runs/actor-runs@{runId}@resurrect.yaml
   "/v2/actor-runs/{runId}/charge":
     $ref: paths/actor-runs/actor-runs@{runId}@charge.yaml
+  "/v2/actor-runs/{runId}/dataset":
+    $ref: paths/actor-runs/actor-runs@{runId}@dataset.yaml
+  "/v2/actor-runs/{runId}/key-value-store":
+    $ref: paths/actor-runs/actor-runs@{runId}@key-value-store.yaml
+  "/v2/actor-runs/{runId}/log":
+    $ref: paths/actor-runs/actor-runs@{runId}@log.yaml
+  "/v2/actor-runs/{runId}/request-queue":
+    $ref: paths/actor-runs/actor-runs@{runId}@request-queue.yaml
+  "/v2/actor-runs/{runId}/dataset/items":
+    $ref: paths/actor-runs/actor-runs@{runId}@dataset@items.yaml
+  "/v2/actor-runs/{runId}/dataset/statistics":
+    $ref: paths/actor-runs/actor-runs@{runId}@dataset@statistics.yaml
+  "/v2/actor-runs/{runId}/key-value-store/keys":
+    $ref: paths/actor-runs/actor-runs@{runId}@key-value-store@keys.yaml
+  "/v2/actor-runs/{runId}/key-value-store/records":
+    $ref: paths/actor-runs/actor-runs@{runId}@key-value-store@records.yaml
+  "/v2/actor-runs/{runId}/key-value-store/records/{recordKey}":
+    $ref: "paths/actor-runs/actor-runs@{runId}@key-value-store@records@{recordKey}.yaml"
+  "/v2/actor-runs/{runId}/request-queue/requests":
+    $ref: paths/actor-runs/actor-runs@{runId}@request-queue@requests.yaml
+  "/v2/actor-runs/{runId}/request-queue/requests/batch":
+    $ref: paths/actor-runs/actor-runs@{runId}@request-queue@requests@batch.yaml
+  "/v2/actor-runs/{runId}/request-queue/requests/unlock":
+    $ref: paths/actor-runs/actor-runs@{runId}@request-queue@requests@unlock.yaml
+  "/v2/actor-runs/{runId}/request-queue/requests/{requestId}":
+    $ref: "paths/actor-runs/actor-runs@{runId}@request-queue@requests@{requestId}.yaml"
+  "/v2/actor-runs/{runId}/request-queue/requests/{requestId}/lock":
+    $ref: "paths/actor-runs/actor-runs@{runId}@request-queue@requests@{requestId}@lock.yaml"
+  "/v2/actor-runs/{runId}/request-queue/head":
+    $ref: paths/actor-runs/actor-runs@{runId}@request-queue@head.yaml
+  "/v2/actor-runs/{runId}/request-queue/head/lock":
+    $ref: paths/actor-runs/actor-runs@{runId}@request-queue@head@lock.yaml
   /v2/actor-builds:
     $ref: paths/actor-builds/actor-builds.yaml
   "/v2/actor-builds/{buildId}":

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

@@ -0,0 +1,35 @@
+get:
+  tags:
+    - Actor runs
+  summary: Get default dataset
+  description: |
+    Returns the default dataset associated with an Actor run.
+
+    This endpoint is a shortcut for getting the run's `defaultDatasetId` and then using the
+    [Get dataset](/api/v2/dataset-get) endpoint.
+
+    This endpoint has the same response as the [Get dataset](/api/v2/dataset-get) endpoint.
+  operationId: actorRun_dataset_get
+  parameters:
+    - $ref: "../../components/parameters/runAndBuildParameters.yaml#/runId"
+  responses:
+    "200":
+      description: ""
+      headers: {}
+      content:
+        application/json:
+          schema:
+            $ref: ../../components/schemas/datasets/DatasetResponse.yaml
+    "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

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

@@ -0,0 +1,197 @@
+get:
+  tags:
+    - Actor runs/Dataset
+  summary: Get dataset items
+  description: |
+    Returns data stored in the default dataset of the Actor run in the desired format.
+
+    This endpoint is a shortcut that resolves the run's `defaultDatasetId` and proxies to the
+    [Get dataset items](/api/v2/dataset-items-get) endpoint.
+  operationId: actorRun_dataset_items_get
+  parameters:
+    - $ref: "../../components/parameters/runAndBuildParameters.yaml#/runId"
+    - $ref: "../../components/parameters/datasetItemsParameters.yaml#/format"
+    - $ref: "../../components/parameters/datasetItemsParameters.yaml#/clean"
+    - $ref: "../../components/parameters/paginationParameters.yaml#/offset"
+    - $ref: "../../components/parameters/datasetItemsParameters.yaml#/limit"
+    - $ref: "../../components/parameters/datasetItemsParameters.yaml#/fields"
+    - $ref: "../../components/parameters/datasetItemsParameters.yaml#/omit"
+    - $ref: "../../components/parameters/datasetItemsParameters.yaml#/unwind"
+    - $ref: "../../components/parameters/datasetItemsParameters.yaml#/flatten"
+    - $ref: "../../components/parameters/datasetItemsParameters.yaml#/descDataset"
+    - $ref: "../../components/parameters/datasetItemsParameters.yaml#/attachment"
+    - $ref: "../../components/parameters/datasetItemsParameters.yaml#/delimiter"
+    - $ref: "../../components/parameters/datasetItemsParameters.yaml#/bom"
+    - $ref: "../../components/parameters/datasetItemsParameters.yaml#/xmlRoot"
+    - $ref: "../../components/parameters/datasetItemsParameters.yaml#/xmlRow"
+    - $ref: "../../components/parameters/datasetItemsParameters.yaml#/skipHeaderRow"
+    - $ref: "../../components/parameters/datasetItemsParameters.yaml#/skipHidden"
+    - $ref: "../../components/parameters/datasetItemsParameters.yaml#/skipEmpty"
+    - $ref: "../../components/parameters/datasetItemsParameters.yaml#/simplified"
+    - name: view
+      in: query
+      description: |
+        Defines the view configuration for dataset items based on the schema definition.
+        This parameter determines how the data will be filtered and presented.
+        For complete specification details, see the [dataset schema documentation](/platform/actors/development/actor-definition/dataset-schema).
+      schema:
+        type: string
+        example: overview
+    - $ref: "../../components/parameters/datasetItemsParameters.yaml#/skipFailedPages"
+  responses:
+    "200":
+      description: ""
+      headers:
+        $ref: ../../components/headers/ApifyPaginationHeaders.yaml
+      content:
+        application/json:
+          schema:
+            type: array
+            items:
+              type: object
+            example: [foo: bar, foo2: bar2]
+        application/jsonl:
+          schema:
+            type: string
+          example: '{"foo":"bar"}\n{"foo2":"bar2"}\n'
+        text/csv:
+          schema:
+            type: string
+          example: 'foo,bar\nfoo2,bar2\n'
+        text/html:
+          schema:
+            type: string
+          example: <table><tr><th>foo</th><th>bar</th></tr><tr><td>foo</td><td>bar</td></tr><tr><td>foo2</td><td>bar2</td></tr></table>
+        application/vnd.openxmlformats-officedocument.spreadsheetml.sheet:
+          schema:
+            type: string
+        application/rss+xml:
+          schema:
+            type: string
+          example: <rss><channel><item><foo>bar</foo></item><item><foo2>bar2</foo2></item></channel></rss>
+        application/xml:
+          schema:
+            type: string
+          example: <items><item><foo>bar</foo></item><item><foo2>bar2</foo2></item></items>
+    "400":
+      $ref: ../../components/responses/BadRequest.yaml
+    "401":
+      $ref: ../../components/responses/Unauthorized.yaml
+    "403":
+      $ref: ../../components/responses/Forbidden.yaml
+    "404":
+      description: Not found - the requested resource was not found.
+      content:
+        application/json:
+          schema:
+            $ref: "../../components/schemas/common/errors/StorageErrors.yaml#/DatasetNotFoundError"
+    "405":
+      $ref: ../../components/responses/MethodNotAllowed.yaml
+    "429":
+      $ref: ../../components/responses/TooManyRequests.yaml
+  deprecated: false
+head:
+  tags:
+    - Actor runs/Dataset
+  summary: Get dataset items headers
+  description: |
+    Returns only the HTTP headers for the dataset items endpoint of the Actor run's default dataset,
+    without the response body.
+  operationId: actorRun_dataset_items_head
+  parameters:
+    - $ref: "../../components/parameters/runAndBuildParameters.yaml#/runId"
+    - $ref: "../../components/parameters/datasetItemsParameters.yaml#/format"
+    - $ref: "../../components/parameters/datasetItemsParameters.yaml#/clean"
+    - $ref: "../../components/parameters/paginationParameters.yaml#/offset"
+    - $ref: "../../components/parameters/datasetItemsParameters.yaml#/limit"
+    - $ref: "../../components/parameters/datasetItemsParameters.yaml#/fields"
+    - $ref: "../../components/parameters/datasetItemsParameters.yaml#/omit"
+    - $ref: "../../components/parameters/datasetItemsParameters.yaml#/unwind"
+    - $ref: "../../components/parameters/datasetItemsParameters.yaml#/flatten"
+    - $ref: "../../components/parameters/datasetItemsParameters.yaml#/descDataset"
+    - $ref: "../../components/parameters/datasetItemsParameters.yaml#/attachment"
+    - $ref: "../../components/parameters/datasetItemsParameters.yaml#/delimiter"
+    - $ref: "../../components/parameters/datasetItemsParameters.yaml#/bom"
+    - $ref: "../../components/parameters/datasetItemsParameters.yaml#/xmlRoot"
+    - $ref: "../../components/parameters/datasetItemsParameters.yaml#/xmlRow"
+    - $ref: "../../components/parameters/datasetItemsParameters.yaml#/skipHeaderRow"
+    - $ref: "../../components/parameters/datasetItemsParameters.yaml#/skipHidden"
+    - $ref: "../../components/parameters/datasetItemsParameters.yaml#/skipEmpty"
+    - $ref: "../../components/parameters/datasetItemsParameters.yaml#/simplified"
+    - name: view
+      in: query
+      description: |
+        Defines the view configuration for dataset items based on the schema definition.
+        This parameter determines how the data will be filtered and presented.
+        For complete specification details, see the [dataset schema documentation](/platform/actors/development/actor-definition/dataset-schema).
+      schema:
+        type: string
+        example: overview
+    - $ref: "../../components/parameters/datasetItemsParameters.yaml#/skipFailedPages"
+  responses:
+    "200":
+      description: ""
+      headers:
+        $ref: ../../components/headers/ApifyPaginationHeaders.yaml
+      content: {}
+    "400":
+      $ref: ../../components/responses/BadRequest.yaml
+  deprecated: false
+post:
+  tags:
+    - Actor runs/Dataset
+  summary: Store items
+  description: |
+    Appends an item or an array of items to the end of the Actor run's default dataset.
+
+    This endpoint is a shortcut that resolves the run's `defaultDatasetId` and proxies to the
+    [Store items](/api/v2/dataset-items-post) endpoint.
+
+    **IMPORTANT:** The limit of request payload size for the dataset is 5 MB.
+    If the array exceeds the size, you'll need to split it into a number of smaller arrays.
+  operationId: actorRun_dataset_items_post
+  parameters:
+    - $ref: "../../components/parameters/runAndBuildParameters.yaml#/runId"
+  requestBody:
+    description: ""
+    content:
+      application/json:
+        schema:
+          oneOf:
+            - $ref: ../../components/schemas/datasets/PutItemsRequest.yaml
+            - type: array
+              items:
+                $ref: ../../components/schemas/datasets/PutItemsRequest.yaml
+          description: ""
+    required: true
+  responses:
+    "201":
+      description: ""
+      headers:
+        Location:
+          content:
+            text/plain:
+              schema:
+                type: string
+              example: https://api.apify.com/v2/datasets/WkzbQMuFYuamGv3YF/items
+      content:
+        application/json:
+          schema:
+            type: object
+          example: {}
+    "400":
+      description: ""
+      headers: {}
+      content:
+        application/json:
+          schema:
+            $ref: ../../components/schemas/datasets/PutItemResponseError.yaml
+    "403":
+      $ref: ../../components/responses/Forbidden.yaml
+    "404":
+      description: Not found - the requested resource was not found.
+      content:
+        application/json:
+          schema:
+            $ref: "../../components/schemas/common/errors/StorageErrors.yaml#/DatasetNotFoundError"
+  deprecated: false

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

@@ -0,0 +1,35 @@
+get:
+  tags:
+    - Actor runs/Dataset
+  summary: Get dataset statistics
+  description: |
+    Returns statistics for the Actor run's default dataset.
+
+    This endpoint is a shortcut that resolves the run's `defaultDatasetId` and proxies to the
+    [Get dataset statistics](/api/v2/dataset-statistics-get) endpoint.
+  operationId: actorRun_dataset_statistics_get
+  parameters:
+    - $ref: "../../components/parameters/runAndBuildParameters.yaml#/runId"
+  responses:
+    "200":
+      description: ""
+      content:
+        application/json:
+          schema:
+            $ref: ../../components/schemas/datasets/DatasetStatisticsResponse.yaml
+    "400":
+      $ref: ../../components/responses/BadRequest.yaml
+    "401":
+      $ref: ../../components/responses/Unauthorized.yaml
+    "403":
+      $ref: ../../components/responses/Forbidden.yaml
+    "404":
+      description: Not found - the requested resource was not found.
+      content:
+        application/json:
+          schema:
+            $ref: "../../components/schemas/common/errors/StorageErrors.yaml#/DatasetNotFoundError"
+    "405":
+      $ref: ../../components/responses/MethodNotAllowed.yaml
+    "429":
+      $ref: ../../components/responses/TooManyRequests.yaml

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

@@ -0,0 +1,35 @@
+get:
+  tags:
+    - Actor runs
+  summary: Get default key-value store
+  description: |
+    Returns the default key-value store associated with an Actor run.
+
+    This endpoint is a shortcut for getting the run's `defaultKeyValueStoreId` and then using the
+    [Get store](/api/v2/keyValueStore-get) endpoint.
+
+    This endpoint has the same response as the [Get store](/api/v2/keyValueStore-get) endpoint.
+  operationId: actorRun_keyValueStore_get
+  parameters:
+    - $ref: "../../components/parameters/runAndBuildParameters.yaml#/runId"
+  responses:
+    "200":
+      description: ""
+      headers: {}
+      content:
+        application/json:
+          schema:
+            $ref: ../../components/schemas/key-value-stores/KeyValueStoreResponse.yaml
+    "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