Skip to content

Commit 3ea0dda

Browse files
authored
docs(openapi): Add undocumented validate input endpoint (#2447)
### Description - Add undocumented validate input endpoint ### Issues Partially implements: #2286
1 parent 2112905 commit 3ea0dda

2 files changed

Lines changed: 64 additions & 0 deletions

File tree

apify-api/openapi/openapi.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -510,6 +510,8 @@ paths:
510510
$ref: "paths/actors/acts@{actorId}@run-sync.yaml"
511511
"/v2/acts/{actorId}/run-sync-get-dataset-items":
512512
$ref: "paths/actors/acts@{actorId}@run-sync-get-dataset-items.yaml"
513+
"/v2/acts/{actorId}/validate-input":
514+
$ref: "paths/actors/acts@{actorId}@validate-input.yaml"
513515
"/v2/acts/{actorId}/runs/{runId}/resurrect":
514516
$ref: "paths/actors/acts@{actorId}@runs@{runId}@resurrect.yaml"
515517
"/v2/acts/{actorId}/runs/last":
Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
post:
2+
tags:
3+
- Actors
4+
summary: Validate Actor input
5+
description: |
6+
Validates the provided input against the Actor's input schema for the specified build.
7+
8+
The endpoint checks whether the JSON payload conforms to the input schema
9+
defined in the Actor's build. If no `build` query parameter is provided,
10+
the `latest` build tag is used by default.
11+
operationId: act_validateInput_post
12+
parameters:
13+
- $ref: "../../components/parameters/runAndBuildParameters.yaml#/actorId"
14+
- name: build
15+
in: query
16+
description: |
17+
Optional tag or number of the Actor build to use for input schema validation.
18+
By default, the `latest` build tag is used.
19+
required: false
20+
style: form
21+
explode: true
22+
schema:
23+
type: string
24+
example: latest
25+
requestBody:
26+
description: JSON input to validate against the Actor's input schema.
27+
content:
28+
application/json:
29+
schema:
30+
type: object
31+
required: true
32+
responses:
33+
"200":
34+
description: ""
35+
headers: {}
36+
content:
37+
application/json:
38+
schema:
39+
type: object
40+
required:
41+
- valid
42+
properties:
43+
valid:
44+
type: boolean
45+
description: Whether the input is valid according to the Actor's input schema.
46+
"400":
47+
$ref: ../../components/responses/BadRequest.yaml
48+
"401":
49+
$ref: ../../components/responses/Unauthorized.yaml
50+
"403":
51+
$ref: ../../components/responses/Forbidden.yaml
52+
"404":
53+
$ref: ../../components/responses/NotFound.yaml
54+
"405":
55+
$ref: ../../components/responses/MethodNotAllowed.yaml
56+
"413":
57+
$ref: ../../components/responses/PayloadTooLarge.yaml
58+
"415":
59+
$ref: ../../components/responses/UnsupportedMediaType.yaml
60+
"429":
61+
$ref: ../../components/responses/TooManyRequests.yaml
62+
deprecated: false

0 commit comments

Comments
 (0)