Aptible Worker API

The worker API from Aptible — 1 operation(s) for worker.

OpenAPI Specification

aptible-worker-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Cloud Worker API
  version: 0.1.0
servers:
- url: /
tags:
- name: worker
paths:
  /api/v1/worker/health-check:
    post:
      operationId: worker_health_check
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/HealthCheckFromWorker'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema: {}
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      summary: Worker Health Check
      tags:
      - worker
components:
  schemas:
    HealthCheckFromWorker:
      example:
        execution_id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        environment_id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        message_id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        message: message
      properties:
        environment_id:
          format: uuid
          title: Environment Id
          type: string
        message_id:
          format: uuid
          title: Message Id
          type: string
        execution_id:
          format: uuid
          title: Execution Id
          type: string
        message:
          title: Message
          type: string
      required:
      - environment_id
      - execution_id
      - message
      title: HealthCheckFromWorker
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    Location_inner:
      anyOf:
      - type: string
      - type: integer
    ValidationError:
      properties:
        loc:
          items:
            $ref: '#/components/schemas/Location_inner'
          title: Location
          type: array
        msg:
          title: Message
          type: string
        type:
          title: Error Type
          type: string
      required:
      - loc
      - msg
      - type
      title: ValidationError
      type: object
  securitySchemes:
    HTTPBearer:
      scheme: bearer
      type: http