Skip to content

Commit 17e6018

Browse files
committed
sync changes from openapi repo and fix blank lines in index page
1 parent c0df7a8 commit 17e6018

File tree

7 files changed

+113
-139
lines changed

7 files changed

+113
-139
lines changed

.github/workflows/openapi.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ jobs:
3636
npm ci
3737
npm run redoc:test
3838
39+
# TODO
3940
# - uses: actions/setup-python@v5
4041
# with:
4142
# python-version: '3.10'

apify-api/openapi/components/schemas/actor-builds/Build.yaml

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,14 +61,20 @@ properties:
6161
inputSchema:
6262
type: string
6363
nullable: true
64+
deprecated: true # Marked as deprecated in favor of actorDefinition.
6465
example: '{\n \"title\": \"Schema for ... }'
6566
readme:
6667
type: string
6768
nullable: true
69+
deprecated: true # Marked as deprecated in favor of actorDefinition.
6870
example: '# Magic Actor\nThis Actor is magic.'
6971
buildNumber:
7072
type: string
7173
example: 0.1.1
74+
actorDefinition:
75+
oneOf:
76+
- $ref: "../actors/ActorDefinition.yaml"
77+
- type: "null"
7278
example:
7379
id: HG7ML7M8z78YcAPEB
7480
actId: janedoe~my-actor
@@ -97,3 +103,39 @@ example:
97103
inputSchema: '{\n \"title\": \"Schema for ... }'
98104
readme: '# Magic Actor\nThis Actor is magic.'
99105
buildNumber: 0.1.1
106+
actorDefinition:
107+
actorSpecification: 1
108+
name: "exmpla-actor"
109+
version: "1.0"
110+
buildTag: "latest"
111+
environmentVariables:
112+
DEBUG_MODE: "false"
113+
input:
114+
type: "object"
115+
properties:
116+
prompt:
117+
type: "string"
118+
description: "The text prompt to generate completions for."
119+
maxTokens:
120+
type: "integer"
121+
description: "The maximum number of tokens to generate."
122+
required:
123+
- prompt
124+
storages:
125+
dataset:
126+
type: "object"
127+
$schema: "http://json-schema.org/draft-07/schema#"
128+
properties:
129+
id:
130+
type: "string"
131+
description: "Unique identifier for the generated text."
132+
text:
133+
type: "string"
134+
description: "The generated text output from the model."
135+
required:
136+
- id
137+
- text
138+
minMemoryMbytes: 512
139+
maxMemoryMbytes: 2048
140+
usesStandbyMode: false
141+
Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
title: ActorDefinition
2+
description: The definition of the Actor, the full specification of this field can be found in [Apify docs](https://docs.apify.com/platform/actors/development/actor-definition/actor-json)
3+
type: object
4+
properties:
5+
actorSpecification:
6+
type: integer
7+
enum: [1]
8+
description: The Actor specification version that this Actor follows. This property must be set to 1.
9+
name:
10+
type: string
11+
description: The name of the Actor.
12+
version:
13+
type: string
14+
pattern: ^[0-9]+\\.[0-9]+$
15+
description: The version of the Actor, specified in the format [Number].[Number], e.g., 0.1, 1.0.
16+
buildTag:
17+
type: string
18+
description: The tag name to be applied to a successful build of the Actor. Defaults to 'latest' if not specified.
19+
environmentVariables:
20+
type: object
21+
additionalProperties:
22+
type: string
23+
description: A map of environment variables to be used during local development and deployment.
24+
dockerfile:
25+
type: string
26+
description: The path to the Dockerfile used for building the Actor on the platform.
27+
dockerContextDir:
28+
type: string
29+
description: The path to the directory used as the Docker context when building the Actor.
30+
readme:
31+
type: string
32+
description: The path to the README file for the Actor.
33+
input:
34+
type: object
35+
description: The input schema object, the full specification can be found in [Apify docs](https://docs.apify.com/platform/actors/development/actor-definition/input-schema)
36+
changelog:
37+
type: string
38+
description: The path to the CHANGELOG file displayed in the Actor's information tab.
39+
storages:
40+
type: object
41+
properties:
42+
dataset:
43+
type: object
44+
description: Defines the schema of items in your dataset, the full specification can be found in [Apify docs](https://docs.apify.com/platform/actors/development/actor-definition/dataset-schema)
45+
minMemoryMbytes:
46+
type: integer
47+
minimum: 256
48+
description: Specifies the minimum amount of memory in megabytes required by the Actor.
49+
maxMemoryMbytes:
50+
type: integer
51+
minimum: 256
52+
description: Specifies the maximum amount of memory in megabytes required by the Actor.
53+
usesStandbyMode:
54+
type: boolean
55+
description: Specifies whether the Actor will have Standby mode enabled.
56+
required:
57+
- actorSpecification
58+
- name
59+
- version

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

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
title: RequestQueue
22
required:
33
- id
4-
- name
54
- userId
65
- createdAt
76
- modifiedAt

0 commit comments

Comments
 (0)