Fix OpenApi specs

vdusek · vdusek · commit b6bdfebd02ee · 2026-01-09T15:52:50.000+01:00
diff --git a/apify-api/openapi/components/schemas/actor-builds/BuildStats.yaml b/apify-api/openapi/components/schemas/actor-builds/BuildStats.yaml
@@ -1,7 +1,5 @@
 title: BuildStats
 required:
-  - durationMillis
-  - runTimeSecs
   - computeUnits
 type: object
 properties:
diff --git a/apify-api/openapi/components/schemas/actor-builds/BuildsMeta.yaml b/apify-api/openapi/components/schemas/actor-builds/BuildsMeta.yaml
@@ -1,7 +1,6 @@
 title: BuildsMeta
 required:
   - origin
-  - clientIp
   - userAgent
 type: object
 properties:
diff --git a/apify-api/openapi/components/schemas/actor-runs/Run.yaml b/apify-api/openapi/components/schemas/actor-runs/Run.yaml
@@ -4,7 +4,6 @@ required:
   - actId
   - userId
   - startedAt
-  - finishedAt
   - status
   - meta
   - stats
@@ -13,8 +12,6 @@ required:
   - defaultKeyValueStoreId
   - defaultDatasetId
   - defaultRequestQueueId
-  - buildNumber
-  - containerUrl
   - generalAccess
 type: object
 properties:
@@ -57,7 +54,7 @@ properties:
   chargedEventCounts:
     type: object
     additionalProperties:
-      $ref: ../actor-pricing-info/ActorChargeEvent.yaml
+      type: integer
   options:
     $ref: ./RunOptions.yaml
   buildId:
diff --git a/apify-api/openapi/components/schemas/actor-runs/RunShort.yaml b/apify-api/openapi/components/schemas/actor-runs/RunShort.yaml
@@ -6,7 +6,6 @@ required:
   - startedAt
   - finishedAt
   - buildId
-  - buildNumber
   - meta
   - usageTotalUsd
   - defaultKeyValueStoreId
diff --git a/apify-api/openapi/components/schemas/actor-runs/RunStats.yaml b/apify-api/openapi/components/schemas/actor-runs/RunStats.yaml
@@ -11,6 +11,9 @@ properties:
   migrationCount:
     type: number
     example: 0
+  rebootCount:
+    type: number
+    example: 0
   restartCount:
     type: number
     example: 0
diff --git a/apify-api/openapi/components/schemas/actors/Actor.yaml b/apify-api/openapi/components/schemas/actors/Actor.yaml
@@ -10,7 +10,6 @@ required:
   - stats
   - versions
   - defaultRunOptions
-  - deploymentKey
 type: object
 properties:
   id:
diff --git a/apify-api/openapi/components/schemas/actors/ActorDefinition.yaml b/apify-api/openapi/components/schemas/actors/ActorDefinition.yaml
@@ -60,7 +60,3 @@ properties:
     usesStandbyMode:
         type: boolean
         description: Specifies whether the Actor will have Standby mode enabled.
-required:
-    - actorSpecification
-    - name
-    - version
diff --git a/apify-api/openapi/components/schemas/actors/ActorStats.yaml b/apify-api/openapi/components/schemas/actors/ActorStats.yaml
@@ -6,8 +6,6 @@ required:
   - totalUsers7Days
   - totalUsers30Days
   - totalUsers90Days
-  - totalMetamorphs
-  - lastRunStartedAt
 type: object
 properties:
   totalBuilds:
diff --git a/apify-api/openapi/components/schemas/actors/DefaultRunOptions.yaml b/apify-api/openapi/components/schemas/actors/DefaultRunOptions.yaml
@@ -1,7 +1,6 @@
 title: defaultRunOptions
 required:
   - build
-  - timeoutSecs
   - memoryMbytes
 type: object
 properties:
diff --git a/apify-api/openapi/components/schemas/actors/Version.yaml b/apify-api/openapi/components/schemas/actors/Version.yaml
@@ -3,7 +3,6 @@ type: object
 required:
   - versionNumber
   - sourceType
-  - buildTag
 properties:
   versionNumber:
     type: string
@@ -27,4 +26,3 @@ properties:
     example: latest
   sourceFiles:
     $ref: ./VersionSourceFiles.yaml
-
diff --git a/apify-api/openapi/components/schemas/datasets/Dataset.yaml b/apify-api/openapi/components/schemas/datasets/Dataset.yaml
@@ -1,7 +1,6 @@
 title: Dataset
 required:
   - id
-  - name
   - userId
   - createdAt
   - modifiedAt
diff --git a/apify-api/openapi/components/schemas/key-value-stores/KeyValueStore.yaml b/apify-api/openapi/components/schemas/key-value-stores/KeyValueStore.yaml
@@ -1,7 +1,6 @@
 title: KeyValueStore
 required:
   - id
-  - name
   - createdAt
   - modifiedAt
   - accessedAt
@@ -42,7 +41,7 @@ properties:
     example: null
   consoleUrl:
     type: string
-    example: 'https://console.apify.com/storage/key-value-stores/27TmTznX9YPeAYhkC'  
+    example: 'https://console.apify.com/storage/key-value-stores/27TmTznX9YPeAYhkC'
   keysPublicUrl:
     type: string
     description: "A public link to access keys of the key-value store directly."
diff --git a/apify-api/openapi/components/schemas/key-value-stores/KeyValueStoreStats.yaml b/apify-api/openapi/components/schemas/key-value-stores/KeyValueStoreStats.yaml
@@ -4,7 +4,6 @@ required:
   - writeCount
   - deleteCount
   - listCount
-  - s3StorageBytes
 type: object
 properties:
   readCount:
diff --git a/apify-api/openapi/components/schemas/key-value-stores/ListOfKeysResponse.yaml b/apify-api/openapi/components/schemas/key-value-stores/ListOfKeysResponse.yaml
@@ -1,44 +1,49 @@
 title: ListOfKeysResponse
 required:
-  - items
-  - count
-  - limit
-  - isTruncated
+  - data
 type: object
 properties:
-  items:
-    type: array
-    items:
-      type: object
-      title: items
-      required:
-        - key
-        - size
-        - recordPublicUrl
-      properties:
-        key:
-          type: string
-          example: second-key
-        size:
-          type: number
-          example: 36
-        recordPublicUrl:
-          type: string
-          description: "A public link to access this record directly."
-          example: 'https://api.apify.com/v2/key-value-stores/WkzbQMuFYuamGv3YF/records/some-key?signature=abc123'
-    description: ''
-  count:
-    type: number
-    example: 2
-  limit:
-    type: number
-    example: 2
-  exclusiveStartKey:
-    type: string
-    example: some-key
-  isTruncated:
-    type: boolean
-    example: true
-  nextExclusiveStartKey:
-    type: string
-    example: third-key
+  data:
+    type: object
+    required:
+      - items
+      - count
+      - limit
+      - isTruncated
+    properties:
+      items:
+        type: array
+        items:
+          type: object
+          title: items
+          required:
+            - key
+            - size
+            - recordPublicUrl
+          properties:
+            key:
+              type: string
+              example: second-key
+            size:
+              type: number
+              example: 36
+            recordPublicUrl:
+              type: string
+              description: "A public link to access this record directly."
+              example: 'https://api.apify.com/v2/key-value-stores/WkzbQMuFYuamGv3YF/records/some-key?signature=abc123'
+        description: ''
+      count:
+        type: number
+        example: 2
+      limit:
+        type: number
+        example: 2
+      exclusiveStartKey:
+        type: string
+        example: some-key
+      isTruncated:
+        type: boolean
+        example: true
+      nextExclusiveStartKey:
+        type: string
+        example: third-key
diff --git a/apify-api/openapi/components/schemas/request-queues/GetHeadAndLockResponse.yaml b/apify-api/openapi/components/schemas/request-queues/GetHeadAndLockResponse.yaml
@@ -51,10 +51,8 @@ properties:
               example: '2022-06-14T23:00:00.000Z'
           required:
             - id
-            - retryCount
             - uniqueKey
             - url
-            - method
             - lockExpiresAt
         description: ''
     required:
diff --git a/apify-api/openapi/components/schemas/request-queues/GetHeadResponse.yaml b/apify-api/openapi/components/schemas/request-queues/GetHeadResponse.yaml
@@ -37,10 +37,8 @@ properties:
               example: GET
           required:
             - id
-            - retryCount
             - uniqueKey
             - url
-            - method
         description: ''
     required:
       - limit
diff --git a/apify-api/openapi/components/schemas/request-queues/ListRequestsResponse.yaml b/apify-api/openapi/components/schemas/request-queues/ListRequestsResponse.yaml
@@ -22,5 +22,4 @@ properties:
         example: Ihnsp8YrvJ8102Kj
     required:
       - items
-      - count
       - limit
diff --git a/apify-api/openapi/components/schemas/request-queues/ProcessedRequest.yaml b/apify-api/openapi/components/schemas/request-queues/ProcessedRequest.yaml
@@ -1,9 +1,6 @@
 title: ProcessedRequest
 required:
-  - requestId
   - uniqueKey
-  - wasAlreadyHandled
-  - wasAlreadyPresent
 type: object
 properties:
   requestId:
diff --git a/apify-api/openapi/components/schemas/request-queues/RequestQueue.yaml b/apify-api/openapi/components/schemas/request-queues/RequestQueue.yaml
@@ -45,6 +45,24 @@ properties:
     example: true
   consoleUrl:
     type: string
-    example: 'https://api.apify.com/v2/request-queues/27TmTznX9YPeAYhkC'  
+    example: 'https://api.apify.com/v2/request-queues/27TmTznX9YPeAYhkC'
+  stats:
+    type: object
+    properties:
+      deleteCount:
+        type: number
+        example: 0
+      headItemReadCount:
+        type: number
+        example: 5
+      readCount:
+        type: number
+        example: 100
+      storageBytes:
+        type: number
+        example: 1024
+      writeCount:
+        type: number
+        example: 10
   generalAccess:
     $ref: ../common/GeneralAccessEnum.yaml
diff --git a/apify-api/openapi/components/schemas/request-queues/RequestQueueItems.yaml b/apify-api/openapi/components/schemas/request-queues/RequestQueueItems.yaml
@@ -1,10 +1,8 @@
 title: RequestQueueItems
 required:
   - id
-  - retryCount
   - uniqueKey
   - url
-  - method
 type: object
 properties:
   id:
diff --git a/apify-api/openapi/components/schemas/request-queues/UserData.yaml b/apify-api/openapi/components/schemas/request-queues/UserData.yaml
@@ -1,5 +1,6 @@
 title: UserData
 type: object
+additionalProperties: true
 properties:
   label:
     type: string
diff --git a/apify-api/openapi/components/schemas/users/UpdateLimitsRequest.yaml b/apify-api/openapi/components/schemas/users/UpdateLimitsRequest.yaml
@@ -5,12 +5,9 @@ properties:
     type: number
     example: 300
     description: |
-      If your platform usage in the billing period exceeds the prepaid usage, you will be charged extra.
-      Setting this property you can update your hard limit on monthly platform usage to prevent accidental overage or to limit the extra charges
+      If your platform usage in the billing period exceeds the prepaid usage, you will be charged extra. Setting this property you can update your hard limit on monthly platform usage to prevent accidental overage or to limit the extra charges.
   dataRetentionDays:
     type: number
     example: 90
     description: |
-      Apify securely stores your ten most recent Actor runs indefinitely, ensuring they are always accessible.
-      Unnamed storages and other Actor runs are automatically deleted after the retention period.
-      If you're subscribed, you can change it to keep data for longer or to limit your usage. [Lear more](https://docs.apify.com/platform/storage/usage#data-retention)
+      Apify securely stores your ten most recent Actor runs indefinitely, ensuring they are always accessible. Unnamed storages and other Actor runs are automatically deleted after the retention period. If you're subscribed, you can change it to keep data for longer or to limit your usage. [Lear more](https://docs.apify.com/platform/storage/usage#data-retention).
