Skip to content

feat(api): added openapi endpoints #1422

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jan 22, 2025
Merged

feat(api): added openapi endpoints #1422

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
00d61f8
feat(api): added OpenAPI response component
danpoletaev Jan 21, 2025
c4004ce
feat(api): added openapi endpoints documentation
danpoletaev Jan 21, 2025
32d14aa
refactor: clean up
danpoletaev Jan 22, 2025
e72b84f
refactor: improved documentation text
danpoletaev Jan 22, 2025
6a436e9
refactor: clean up
danpoletaev Jan 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
348 changes: 348 additions & 0 deletions apify-api/openapi/components/schemas/actor-builds/GetOpenApiResponse.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,348 @@
title: GetOpenApiResponse
type: object
properties:
openapi:
type: string
example: 3.0.1
info:
type: object
properties:
title:
type: string
example: Your Magic Actor
version:
type: string
example: "1.0"
Copy link
Member

@B4nan B4nan Jan 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the quoting is inconsistent here, lets use single quotes everywhere (there are more places using double quotes, not just in this file)

Copy link
Contributor Author

@danpoletaev danpoletaev Jan 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hm, fixed in the files I've changed, but it is harder to change everywhere else. I think it should be fixed in lint, but we'll need to set up yaml lint for that...

x-build-id:
type: string
example: "ID of build"
servers:
type: array
items:
type: object
properties:
url:
type: string
example: https://api.apify.com/v2
paths:
type: object
properties:
/acts/<username>~<actor>/run-sync-get-dataset-items:
type: object
properties:
post:
type: object
properties:
operationId:
type: string
example: run-sync-get-dataset-items
x-openai-isConsequential:
type: boolean
example: false
summary:
type: string
example: Executes an Actor, waits for its completion, and returns Actor's dataset items in response.
tags:
type: array
items:
type: string
example: ["Run Actor"]
requestBody:
type: object
properties:
required:
type: boolean
example: true
content:
type: object
properties:
application/json:
type: object
properties:
schema:
type: object
properties:
$ref:
type: string
example: '#/components/schemas/inputSchema'
parameters:
type: array
items:
type: object
properties:
name:
type: string
example: token
in:
type: string
example: query
required:
type: boolean
example: true
schema:
type: object
properties:
type:
type: string
example: string
description:
type: string
example: Enter your Apify token here
responses:
type: object
properties:
'200':
type: object
properties:
description:
type: string
example: OK
/acts/<username>~<actor>/runs:
type: object
properties:
post:
type: object
properties:
operationId:
type: string
example: runs
x-openai-isConsequential:
type: boolean
example: false
summary:
type: string
example: Executes an Actor and returns information about the initiated run in response.
tags:
type: array
items:
type: string
example: ["Run Actor"]
requestBody:
type: object
properties:
required:
type: boolean
example: true
content:
type: object
properties:
application/json:
type: object
properties:
schema:
type: object
properties:
$ref:
type: string
example: '#/components/schemas/inputSchema'
parameters:
type: array
items:
type: object
properties:
name:
type: string
in:
type: string
example: query
required:
type: boolean
schema:
type: object
properties:
type:
type: string
description:
type: string
responses:
type: object
properties:
'200':
type: object
properties:
description:
type: string
example: OK
content:
type: object
properties:
application/json:
type: object
properties:
schema:
type: object
properties:
$ref:
type: string
example: '#/components/schemas/runsResponseSchema'
/acts/<username>~<actor>/run-sync:
type: object
properties:
post:
type: object
properties:
operationId:
type: string
example: run-sync
x-openai-isConsequential:
type: boolean
example: false
summary:
type: string
example: Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.
tags:
type: array
items:
type: string
example: ["Run Actor"]
requestBody:
type: object
properties:
required:
type: boolean
example: true
content:
type: object
properties:
application/json:
type: object
properties:
schema:
type: object
properties:
$ref:
type: string
example: '#/components/schemas/inputSchema'
parameters:
type: array
items:
type: object
properties:
name:
type: string
in:
type: string
example: query
required:
type: boolean
schema:
type: object
properties:
type:
type: string
description:
type: string
responses:
type: object
properties:
'200':
type: object
properties:
description:
type: string
example: OK
components:
type: object
properties:
schemas:
type: object
properties:
inputSchema:
type: object
properties:
type:
type: string
example: object
runsResponseSchema:
type: object
properties:
type:
type: string
example: object
properties:
type: object
properties:
data:
type: object
properties:
type:
type: string
example: object
properties:
type: object
properties:
id:
type: object
properties:
type:
type: string
example: string
actId:
type: object
properties:
type:
type: string
example: string
userId:
type: object
properties:
type:
type: string
example: string
startedAt:
type: object
properties:
type:
type: string
example: string
format:
type: string
example: date-time
example:
type: string
example: "2025-01-08T00:00:00.000Z"
finishedAt:
type: object
properties:
type:
type: string
example: string
format:
type: string
example: date-time
example:
type: string
example: "2025-01-08T00:00:00.000Z"
status:
type: object
properties:
type:
type: string
example: string
example:
type: string
example: "READY"
meta:
type: object
properties:
type:
type: string
example: object
properties:
type: object
properties:
origin:
type: object
properties:
type:
type: string
example: string
example:
type: string
example: "API"
userAgent:
type: object
properties:
type:
type: string
example: string
18 changes: 18 additions & 0 deletions apify-api/openapi/components/tags.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -251,6 +251,15 @@
```
In order to save new items to the dataset, send HTTP POST request with JSON payload to the same URL.
- name: Actors/Get OpenAPI specification
x-displayName: Get OpenAPI specification
x-parent-tag-name: Actors
x-trait: 'true'
description: |
To obtain the OpenAPI schema for actor builds, two similar endpoints are available:
- [First Endpoint](/api/v2/act-openapi-specification-get): Requires both `actorId` and `buildId`. You can pass `default` instead of buildId to retrieve the OpenAPI schema for the default actor build.
- [Second Endpoint](/api/v2/actor-build-openapi-specification-get): Requires only `buildId`.
- name: Actor tasks
x-displayName: Actor tasks
x-legacy-doc-urls:
Expand Down Expand Up @@ -548,6 +557,15 @@
- '#tag/Actor-buildsBuild-log'
x-trait: 'true'
description: Check out [Logs](#/reference/logs) for full reference.
- name: Actor builds/Get OpenAPI specification
x-displayName: Get OpenAPI specification
x-parent-tag-name: Actor builds
x-trait: 'true'
description: |
To obtain the OpenAPI schema for actor builds, two similar endpoints are available:
- [First Endpoint](/api/v2/act-openapi-specification-get): Requires both `actorId` and `buildId`. You can pass `default` instead of buildId to retrieve the OpenAPI schema for the default actor build.
- [Second Endpoint](/api/v2/actor-build-openapi-specification-get): Requires only `buildId`.
- name: Key-value stores
x-displayName: Key-value stores
x-legacy-doc-urls:
Expand Down
2 changes: 2 additions & 0 deletions apify-api/openapi/components/x-tag-groups.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
- Actors/Metamorph run
- Actors/Resurrect run
- Actors/Last run object and its storages
- Actors/Get OpenAPI specification
- name: Actor tasks
tags:
- Actor tasks
Expand Down Expand Up @@ -50,6 +51,7 @@
- Actor builds/Delete build
- Actor builds/Abort build
- Actor builds/Build log
- Actor builds/Get OpenAPI specification
- name: Key-value stores
tags:
- Key-value stores
Expand Down
Loading
Loading