apify-docs/apify-api/openapi/components/schemas/actors/UpdateActorRequest.yaml at 3b28c7aeebbb3f77c51a6a89f7fc017e7a689eac · apify/apify-docs · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
title: UpdateActorRequest
type: object
properties:
  name:
    type: string
    examples: [MyActor]
  description:
    type: [string, "null"]
    examples: [My favourite actor!]
  isPublic:
    type: boolean
    examples: [false]
  actorPermissionLevel:
    anyOf:
      - $ref: ./ActorPermissionLevel.yaml
      - type: "null"
  seoTitle:
    type: [string, "null"]
    examples: [My actor]
  seoDescription:
    type: [string, "null"]
    examples: [My actor is the best]
  title:
    type: [string, "null"]
    examples: [My Actor]
  restartOnError:
    type: boolean
    examples: [false]
    deprecated: true # Use defaultRunOptions.restartOnError instead
  versions:
    type: array
    items:
      $ref: ./CreateOrUpdateVersionRequest.yaml
    description: ""
  pricingInfos:
    type: array
    items:
      $ref: ../actor-pricing-info/ActorRunPricingInfo.yaml
  categories:
    type: [array, "null"]
    items:
      type: string
    description: ""
  defaultRunOptions:
    anyOf:
      - $ref: ./DefaultRunOptions.yaml
      - type: "null"
  taggedBuilds:
    type: [object, "null"]
    description: |
      An object to modify tags on the Actor's builds. The key is the tag name (e.g., _latest_), and the value is either an object with a `buildId` or `null`.

      This operation is a patch; any existing tags that you omit from this object will be preserved.

      - **To create or reassign a tag**, provide the tag name with a `buildId`. e.g., to assign the _latest_ tag:

        &nbsp;

        ```json
        {
          "latest": {
            "buildId": "z2EryhbfhgSyqj6Hn"
          }
        }
        ```

      - **To remove a tag**, provide the tag name with a `null` value. e.g., to remove the _beta_ tag:

        &nbsp;

        ```json
        {
          "beta": null
        }
        ```

      - **To perform multiple operations**, combine them. The following reassigns _latest_ and removes _beta_, while preserving any other existing tags.

        &nbsp;

        ```json
        {
          "latest": {
            "buildId": "z2EryhbfhgSyqj6Hn"
          },
          "beta": null
        }
        ```
    additionalProperties:
      $ref: ./BuildTag.yaml
    example:
      latest:
        buildId: z2EryhbfhgSyqj6Hn
      beta: null
  actorStandby:
    anyOf:
      - $ref: ./ActorStandby.yaml
      - type: "null"
  exampleRunInput:
    anyOf:
      - $ref: ./ExampleRunInput.yaml
      - type: "null"
  isDeprecated:
    type: [boolean, "null"]