api-spec/scheduler/api.yml at main · cycleplatform/api-spec · 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
openapi: 3.1.0
servers:
  - description: Cycle Scheduler Service
    url: "http://env-scheduler"
info:
  version: 1.0.0
  title: Cycle Scheduler API
  contact:
    email: support@cycle.io
  license:
    name: Apache-2.0
    url: http://www.apache.org/licenses/LICENSE-2.0
  x-logo:
    url: https://static.cycle.io/icons/logo/logo-white.svg

security:
  - accessKey: []

tags:
  - name: Functions
    description: "Containers configured to be pre-allocated and started on demand - useful for batch processing and tasks with elastic demand. Managed by a scheduler service (this API) on a per-environment basis."

paths:
  # v1
  ## functions
  /v1/functions/{containerId}/claim:
    $ref: paths/functions/claim.yml
  /v1/functions/{containerId}/spawn:
    $ref: paths/functions/spawn.yml
  /v1/functions/{containerId}/release:
    $ref: paths/functions/release.yml
  /v1/functions/{containerId}/active:
    $ref: paths/functions/active.yml

components:
  securitySchemes:
    accessKey:
      name: X-CYCLE-ACCESS-KEY
      in: header
      type: apiKey
      description: Access key that has been set in the scheduler config.