docs: Add PPE-related properties to OpenAPI spec (#1492)

- closes #1368

Author: janbuchar

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

@@ -0,0 +1,13 @@
+title: ActorChargeEvent
+type: object
+required:
+  - eventPriceUsd
+  - eventTitle
+  - eventDescription
+properties:
+  eventPriceUsd:
+    type: number
+  eventTitle:
+    type: string
+  eventDescription:
+    type: string

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

@@ -0,0 +1,13 @@
+title: ActorRunPricingInfo
+discriminator:
+  propertyName: pricingModel
+  mapping:
+    PAY_PER_EVENT: ./PayPerEventActorPricingInfo.yaml
+    PRICE_PER_DATASET_ITEM: ./PricePerDatasetItemActorPricingInfo.yaml
+    FLAT_PRICE_PER_MONTH: ./FlatPricePerMonthActorPricingInfo.yaml
+    FREE: ./FreeActorPricingInfo.yaml
+oneOf:
+  - $ref: ./PayPerEventActorPricingInfo.yaml
+  - $ref: ./PricePerDatasetItemActorPricingInfo.yaml
+  - $ref: ./FlatPricePerMonthActorPricingInfo.yaml
+  - $ref: ./FreeActorPricingInfo.yaml

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

@@ -0,0 +1,32 @@
+title: CommonActorPricingInfo
+type: object
+required:
+    - apifyMarginPercentage
+    - createdAt
+    - startedAt
+properties:
+  apifyMarginPercentage:
+    type: number
+    description: "In [0, 1], fraction of pricePerUnitUsd that goes to Apify"
+  createdAt:
+    type: string
+    format: date-time
+    description: "When this pricing info record has been created"
+  startedAt:
+    type: string
+    format: date-time
+    description: "Since when is this pricing info record effective for a given Actor"
+  notifiedAboutFutureChangeAt:
+    type: string
+    format: date-time
+    nullable: true
+    x-internal: true
+  notifiedAboutChangeAt:
+    type: string
+    format: date-time
+    nullable: true
+    x-internal: true
+  reasonForChange:
+    type: string
+    nullable: true
+    x-internal: true

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

@@ -0,0 +1,18 @@
+title: FlatPricePerMonthActorPricingInfo
+allOf:
+  - $ref: "./CommonActorPricingInfo.yaml"
+  - type: object
+    required:
+      - pricingModel
+      - pricePerUnitUsd
+      - trialMinutes
+    properties:
+      pricingModel:
+        type: string
+        enum: [FLAT_PRICE_PER_MONTH]
+      trialMinutes:
+        type: number
+        description: "For how long this Actor can be used for free in trial period"
+      pricePerUnitUsd:
+        type: number
+        description: "Monthly flat price in USD"

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

@@ -0,0 +1,10 @@
+title: FreeActorPricingInfo
+allOf:
+  - $ref: "./CommonActorPricingInfo.yaml"
+  - type: object
+    required:
+      - pricingModel
+    properties:
+      pricingModel:
+        type: string
+        enum: [FREE]

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

@@ -0,0 +1,21 @@
+title: PayPerEventActorPricingInfo
+allOf:
+  - $ref: "./CommonActorPricingInfo.yaml"
+  - type: object
+    required:
+      - pricingModel
+      - pricingPerEvent
+    properties:
+      pricingModel:
+        type: string
+        enum: [PAY_PER_EVENT]
+      pricingPerEvent:
+        type: object
+        properties:
+          actorChargeEvents:
+            type: object
+            additionalProperties:
+              $ref: ./ActorChargeEvent.yaml
+      minimalMaxTotalChargeUsd:
+        type: number
+        nullable: true

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

@@ -0,0 +1,17 @@
+title: PricePerDatasetItemActorPricingInfo
+allOf:
+  - $ref: "./CommonActorPricingInfo.yaml"
+  - type: object
+    required:
+      - pricingModel
+      - pricePerUnitUsd
+      - unitName
+    properties:
+      pricingModel:
+        type: string
+        enum: [PRICE_PER_DATASET_ITEM]
+      unitName:
+        type: string
+        description: "Name of the unit that is being charged"
+      pricePerUnitUsd:
+        type: number

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

@@ -49,8 +49,14 @@ properties:
     example: false
   meta:
     $ref: ./RunMeta.yaml
+  pricingInfo:
+    $ref: ../actor-pricing-info/ActorRunPricingInfo.yaml
   stats:
     $ref: ./RunStats.yaml
+  chargedEventCounts:
+    type: object
+    additionalProperties:
+      $ref: ../actor-pricing-info/ActorChargeEvent.yaml
   options:
     $ref: ./RunOptions.yaml
   buildId:

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

@@ -49,6 +49,10 @@ properties:
     items:
       $ref: "./Version.yaml"
     description: ''
+  pricingInfos:
+    type: array
+    items:
+      $ref: ../actor-pricing-info/ActorRunPricingInfo.yaml
   defaultRunOptions:
       $ref: ./DefaultRunOptions.yaml
   exampleRunInput:

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

@@ -35,6 +35,10 @@ properties:
       $ref: "./Version.yaml"
     description: ''
     nullable: true
+  pricingInfos:
+    type: array
+    items:
+      $ref: ../actor-pricing-info/ActorRunPricingInfo.yaml
   categories:
     type: array
     items: