docs(openapi): Autofix OpenAPI spec validation errors

AGENTS.md

@@ -71,6 +71,22 @@ Add code samples by creating files in `apify-api/openapi/code_samples/{javascrip
 - Each endpoint that has `runs/last` in its path or that has any ID related parameter (for example `actorId`, `buildId`, `runId`, `datasetId` and so on) should have at least one 404 (Not Found) error.
 - Each endpoint that has `requestBody` should have at least following error responses: 413 (Payload Too Large), 415 (Unsupported Media Type).
 
+#### Syntax hints
+- Instead of using one item `enum`, use `const`:
+Avoid this:
+```yaml
+schema:
+  type: string
+  enum:
+    - "constantValue"
+```
+Use this:
+```yaml
+schema:
+  type: string
+  const: "constantValue"
+```
+
 ### Theme system
 
 Uses `@apify/docs-theme` package - a shared theme across all 6+ documentation repos. Don't modify theme files directly. Changes to the theme propagate via CI to all projects.

apify-api/openapi/components/objects/key-value-stores/key-value-stores@{storeId}@records@{recordKey}put.yaml

@@ -14,6 +14,7 @@ shared: &shared
           - gzip
           - deflate
           - br
+          - identity
         type: string
   requestBody:
     description: ""

apify-api/openapi/components/parameters/datasetItemsParameters.yaml

@@ -206,6 +206,17 @@ descDataset:
     type: boolean
     example: true
 
+view:
+  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
+
 skipFailedPages:
   name: skipFailedPages
   in: query

apify-api/openapi/components/parameters/runAndBuildParameters.yaml

@@ -258,10 +258,12 @@ status:
     Single status or comma-separated list of statuses, see ([available
     statuses](https://docs.apify.com/platform/actors/running/runs-and-builds#lifecycle)). Used to filter runs by the specified statuses only.
   style: form
-  explode: true
+  explode: false
   schema:
-    type: string
-    example: SUCCEEDED
+    type: array
+    items:
+      type: string
+    example: [SUCCEEDED]
 
 startedAfter:
   name: startedAfter
@@ -271,6 +273,7 @@ startedAfter:
     The value must be a valid ISO 8601 datetime string (UTC).
   style: form
   explode: true
+  allowReserved: true
   schema:
     type: string
     format: date-time
@@ -284,6 +287,7 @@ startedBefore:
     The value must be a valid ISO 8601 datetime string (UTC).
   style: form
   explode: true
+  allowReserved: true
   schema:
     type: string
     format: date-time

apify-api/openapi/components/schemas/actor-pricing-info/FlatPricePerMonthActorPricingInfo.yaml

@@ -8,7 +8,8 @@ allOf:
       - trialMinutes
     properties:
       pricingModel:
-        $ref: ./PricingModel.yaml
+        type: string
+        const: FLAT_PRICE_PER_MONTH
       trialMinutes:
         type: integer
         description: For how long this Actor can be used for free in trial period

apify-api/openapi/components/schemas/actor-pricing-info/FreeActorPricingInfo.yaml

@@ -6,4 +6,5 @@ allOf:
       - pricingModel
     properties:
       pricingModel:
-        $ref: ./PricingModel.yaml
+        type: string
+        const: FREE

apify-api/openapi/components/schemas/actor-pricing-info/PayPerEventActorPricingInfo.yaml

@@ -7,7 +7,8 @@ allOf:
       - pricingPerEvent
     properties:
       pricingModel:
-        $ref: ./PricingModel.yaml
+        type: string
+        const: PAY_PER_EVENT
       pricingPerEvent:
         type: object
         properties:

apify-api/openapi/components/schemas/actor-pricing-info/PricePerDatasetItemActorPricingInfo.yaml

@@ -8,7 +8,8 @@ allOf:
       - unitName
     properties:
       pricingModel:
-        $ref: ./PricingModel.yaml
+        type: string
+        const: PRICE_PER_DATASET_ITEM
       unitName:
         type: string
         description: Name of the unit that is being charged

apify-api/openapi/components/schemas/actor-runs/RunOptions.yaml

@@ -23,7 +23,7 @@ properties:
     minimum: 0
     examples: [2048]
   maxItems:
-    type: integer
+    type: [integer, "null"]
     minimum: 1
     examples: [1000]
   maxTotalChargeUsd:

apify-api/openapi/components/schemas/actor-tasks/CreateTaskRequest.yaml

@@ -1,7 +1,6 @@
 title: CreateTaskRequest
 required:
   - actId
-  - name
 type: object
 properties:
   actId:

apify-api/openapi/components/schemas/actors/SourceCodeFile.yaml

@@ -1,8 +1,6 @@
 title: SourceCodeFile
 type: object
 required:
-  - format
-  - content
   - name
 properties:
   format:

apify-api/openapi/components/schemas/request-queues/RequestBase.yaml

@@ -15,7 +15,7 @@ properties:
     description: The final URL that was loaded, after redirects (if any).
     examples: [https://apify.com/jobs]
   payload:
-    type: [object, "null"]
+    type: [string, object, "null"]
     description: The request payload, typically used with POST or PUT requests.
     examples: [null]
   headers:

apify-api/openapi/components/schemas/request-queues/SharedProperties.yaml

@@ -15,7 +15,6 @@ UniqueKey:
 
 RequestUrl:
   type: string
-  format: uri
   description: The URL of the request.
   examples: [https://apify.com]
 

apify-api/openapi/components/schemas/webhooks/WebhookCreate.yaml

@@ -27,7 +27,6 @@ properties:
     examples: [false]
   requestUrl:
     type: string
-    format: uri
     examples: ["http://example.com/"]
   payloadTemplate:
     type: [string, "null"]

apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@run-sync-get-dataset-items.yaml

@@ -49,6 +49,7 @@ get:
     - $ref: "../../components/parameters/datasetItemsParameters.yaml#/skipHidden"
     - $ref: "../../components/parameters/datasetItemsParameters.yaml#/skipEmpty"
     - $ref: "../../components/parameters/datasetItemsParameters.yaml#/simplified"
+    - $ref: "../../components/parameters/datasetItemsParameters.yaml#/view"
     - $ref: "../../components/parameters/datasetItemsParameters.yaml#/skipFailedPages"
   responses:
     "201":
@@ -147,6 +148,7 @@ post:
     - $ref: "../../components/parameters/datasetItemsParameters.yaml#/skipHidden"
     - $ref: "../../components/parameters/datasetItemsParameters.yaml#/skipEmpty"
     - $ref: "../../components/parameters/datasetItemsParameters.yaml#/simplified"
+    - $ref: "../../components/parameters/datasetItemsParameters.yaml#/view"
     - $ref: "../../components/parameters/datasetItemsParameters.yaml#/skipFailedPages"
   requestBody:
     description: ""
@@ -156,6 +158,8 @@ post:
           type: object
         example:
           foo: bar
+      "*/*":
+        schema: {}
     required: true
   responses:
     "201":

apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@run-sync.yaml

@@ -115,6 +115,8 @@ post:
           type: object
         example:
           foo: bar
+      "*/*":
+        schema: {}
     required: true
   responses:
     "201":

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

@@ -106,6 +106,8 @@ post:
           type: object
         example:
           foo: bar
+      "*/*":
+        schema: {}
     required: true
   responses:
     "201":

apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@runs@last.yaml

@@ -53,6 +53,7 @@ get:
   parameters:
     - $ref: "../../components/parameters/runAndBuildParameters.yaml#/actorTaskId"
     - $ref: "../../components/parameters/runAndBuildParameters.yaml#/statusLastRun"
+    - $ref: "../../components/parameters/runAndBuildParameters.yaml#/waitForFinishRun"
   responses:
     "200":
       description: ""

apify-api/openapi/paths/actors/acts@{actorId}@run-sync-get-dataset-items.yaml

@@ -55,6 +55,7 @@ post:
     - $ref: "../../components/parameters/datasetItemsParameters.yaml#/skipHidden"
     - $ref: "../../components/parameters/datasetItemsParameters.yaml#/skipEmpty"
     - $ref: "../../components/parameters/datasetItemsParameters.yaml#/simplified"
+    - $ref: "../../components/parameters/datasetItemsParameters.yaml#/view"
     - $ref: "../../components/parameters/datasetItemsParameters.yaml#/skipFailedPages"
   requestBody:
     description: ""
@@ -64,6 +65,8 @@ post:
           type: object
         example:
           foo: bar
+      "*/*":
+        schema: {}
     required: true
   responses:
     "201":
@@ -156,6 +159,7 @@ get:
     - $ref: "../../components/parameters/datasetItemsParameters.yaml#/skipHidden"
     - $ref: "../../components/parameters/datasetItemsParameters.yaml#/skipEmpty"
     - $ref: "../../components/parameters/datasetItemsParameters.yaml#/simplified"
+    - $ref: "../../components/parameters/datasetItemsParameters.yaml#/view"
     - $ref: "../../components/parameters/datasetItemsParameters.yaml#/skipFailedPages"
   responses:
     "201":

apify-api/openapi/paths/actors/acts@{actorId}@run-sync.yaml

@@ -42,6 +42,8 @@ post:
           type: object
         example:
           foo: bar
+      "*/*":
+        schema: {}
     required: true
   responses:
     "201":

apify-api/openapi/paths/actors/acts@{actorId}@runs.yaml

@@ -117,6 +117,8 @@ post:
           type: object
         example:
           foo: bar
+      "*/*":
+        schema: {}
     required: true
   responses:
     "201":

apify-api/openapi/paths/actors/acts@{actorId}@runs@last.yaml

@@ -60,6 +60,7 @@ get:
   parameters:
     - $ref: "../../components/parameters/runAndBuildParameters.yaml#/actorId"
     - $ref: "../../components/parameters/runAndBuildParameters.yaml#/statusLastRun"
+    - $ref: "../../components/parameters/runAndBuildParameters.yaml#/waitForFinishRun"
   responses:
     "200":
       description: ""

apify-api/openapi/paths/actors/acts@{actorId}@versions@{versionNumber}.yaml

@@ -72,7 +72,7 @@ delete:
         application/json:
           schema:
             oneOf:
-              - $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorNotFoundError"
+              - $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/RecordOrTokenNotFoundError"
               - $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorVersionNotFoundError"
     "405":
       $ref: ../../components/responses/MethodNotAllowed.yaml

apify-api/openapi/paths/datasets/datasets@{datasetId}@items.yaml

@@ -173,15 +173,7 @@ get:
     - $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#/view"
     - $ref: "../../components/parameters/datasetItemsParameters.yaml#/skipFailedPages"
     - $ref: "../../components/parameters/storageParameters.yaml#/signature"
   responses:
@@ -274,15 +266,7 @@ head:
     - $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#/view"
     - $ref: "../../components/parameters/datasetItemsParameters.yaml#/skipFailedPages"
     - $ref: "../../components/parameters/storageParameters.yaml#/signature"
   responses:

apify-api/openapi/paths/request-queues/request-queues@{queueId}@requests.yaml

@@ -39,13 +39,15 @@ get:
       in: query
       description: Filter requests by their state. Possible values are `locked` and `pending`. (Is not compatible with deprecated `exclusiveStartId` parameter.)
       style: form
-      explode: true
+      explode: false
       schema:
-        type: string
-        enum:
-          - locked
-          - pending
-        example: locked
+        type: array
+        items:
+          type: string
+          enum:
+            - locked
+            - pending
+        example: [locked]
   responses:
     "200":
       description: ""

apify-api/openapi/paths/request-queues/request-queues@{queueId}@requests@batch.yaml

@@ -92,9 +92,8 @@ delete:
       required: true
       style: simple
       schema:
-        enum:
-          - application/json
         type: string
+        const: application/json
     - $ref: "../../components/parameters/storageParameters.yaml#/clientKey"
   requestBody:
     description: ""