source-git / osbuild-composer

Clone
Source Code
GIT

Blame internal/worker/api/openapi.yml

c8 c8s master
  1.   509fd43ac82544c04c8310db8c70992d6aa5692e
  2.   internal
  3.   worker
  4.   api
  5.   openapi.yml
Blob History Raw
Packit Service 509fd4 
openapi: 3.0.0
Packit Service 509fd4 
info:
Packit Service 509fd4 
  title: OSBuild Composer - Worker
Packit Service 509fd4 
  version: '1'
Packit Service 509fd4 
  description: This is an API for workers to request and handle jobs.
Packit Service 509fd4 
servers:
Packit Service 509fd4 
  - url: /api/worker/v1
Packit Service 509fd4 
paths:
Packit Service 509fd4 
  /status:
Packit Service 509fd4 
    get:
Packit Service 509fd4 
      summary: status
Packit Service 509fd4 
      tags: []
Packit Service 509fd4 
      responses:
Packit Service 509fd4 
        '200':
Packit Service 509fd4 
          description: OK
Packit Service 509fd4 
          headers: {}
Packit Service 509fd4 
          content:
Packit Service 509fd4 
            application/json:
Packit Service 509fd4 
              schema:
Packit Service 509fd4 
                type: object
Packit Service 509fd4 
                properties:
Packit Service 509fd4 
                  status:
Packit Service 509fd4 
                    type: string
Packit Service 509fd4 
                    enum:
Packit Service 509fd4 
                      - OK
Packit Service 509fd4 
                required:
Packit Service 509fd4 
                  - status
Packit Service 509fd4 
        4XX:
Packit Service 509fd4 
          content:
Packit Service 509fd4 
            application/json:
Packit Service 509fd4 
              schema:
Packit Service 509fd4 
                $ref: '#/components/schemas/Error'
Packit Service 509fd4 
        5XX:
Packit Service 509fd4 
          description: ''
Packit Service 509fd4 
          content:
Packit Service 509fd4 
            application/json:
Packit Service 509fd4 
              schema:
Packit Service 509fd4 
                $ref: '#/components/schemas/Error'
Packit Service 509fd4 
      operationId: GetStatus
Packit Service 509fd4 
      description: Simple status handler to check whether the service is up.
Packit Service 509fd4 
  /jobs:
Packit Service 509fd4 
    post:
Packit Service 509fd4 
      summary: Request a job
Packit Service 509fd4 
      tags: []
Packit Service 509fd4 
      responses:
Packit Service 509fd4 
        '201':
Packit Service 509fd4 
          description: Created
Packit Service 509fd4 
          content:
Packit Service 509fd4 
            application/json:
Packit Service 509fd4 
              schema:
Packit Service 509fd4 
                type: object
Packit Service 509fd4 
                additionalProperties: false
Packit Service 509fd4 
                properties:
Packit Service 509fd4 
                  id:
Packit Service 509fd4 
                    type: string
Packit Service 509fd4 
                    format: uuid
Packit Service 509fd4 
                  location:
Packit Service 509fd4 
                    type: string
Packit Service 509fd4 
                  artifact_location:
Packit Service 509fd4 
                    type: string
Packit Service 509fd4 
                  type:
Packit Service 509fd4 
                    type: string
Packit Service 509fd4 
                    enum:
Packit Service 509fd4 
                      - osbuild
Packit Service 509fd4 
                  args: {}
Packit Service 509fd4 
                  dynamic_args:
Packit Service 509fd4 
                    type: array
Packit Service 509fd4 
                    items: {}
Packit Service 509fd4 
                required:
Packit Service 509fd4 
                  - type
Packit Service 509fd4 
                  - location
Packit Service 509fd4 
                  - id
Packit Service 509fd4 
        4XX:
Packit Service 509fd4 
          content:
Packit Service 509fd4 
            application/json:
Packit Service 509fd4 
              schema:
Packit Service 509fd4 
                $ref: '#/components/schemas/Error'
Packit Service 509fd4 
        5XX:
Packit Service 509fd4 
          description: ''
Packit Service 509fd4 
          content:
Packit Service 509fd4 
            application/json:
Packit Service 509fd4 
              schema:
Packit Service 509fd4 
                $ref: '#/components/schemas/Error'
Packit Service 509fd4 
      operationId: RequestJob
Packit Service 509fd4 
      requestBody:
Packit Service 509fd4 
        content:
Packit Service 509fd4 
          application/json:
Packit Service 509fd4 
            schema:
Packit Service 509fd4 
              type: object
Packit Service 509fd4 
              additionalProperties: false
Packit Service 509fd4 
              properties:
Packit Service 509fd4 
                types:
Packit Service 509fd4 
                  type: array
Packit Service 509fd4 
                  items:
Packit Service 509fd4 
                    type: string
Packit Service 509fd4 
                    enum:
Packit Service 509fd4 
                      - osbuild
Packit Service 509fd4 
                arch:
Packit Service 509fd4 
                  type: string
Packit Service 509fd4 
              required:
Packit Service 509fd4 
                - types
Packit Service 509fd4 
                - arch
Packit Service 509fd4 
        description: ''
Packit Service 509fd4 
      description: Requests a job. This operation blocks until a job is available.
Packit Service 509fd4 
    parameters: []
Packit Service 509fd4 
  '/jobs/{token}':
Packit Service 509fd4 
    parameters:
Packit Service 509fd4 
      - schema:
Packit Service 509fd4 
          type: string
Packit Service 509fd4 
        name: token
Packit Service 509fd4 
        in: path
Packit Service 509fd4 
        required: true
Packit Service 509fd4 
    get:
Packit Service 509fd4 
      summary: Get running job
Packit Service 509fd4 
      tags: []
Packit Service 509fd4 
      responses:
Packit Service 509fd4 
        '200':
Packit Service 509fd4 
          description: OK
Packit Service 509fd4 
          content:
Packit Service 509fd4 
            application/json:
Packit Service 509fd4 
              schema:
Packit Service 509fd4 
                type: object
Packit Service 509fd4 
                properties:
Packit Service 509fd4 
                  canceled:
Packit Service 509fd4 
                    type: boolean
Packit Service 509fd4 
                required:
Packit Service 509fd4 
                  - canceled
Packit Service 509fd4 
        4XX:
Packit Service 509fd4 
          description: ''
Packit Service 509fd4 
          content:
Packit Service 509fd4 
            application/json:
Packit Service 509fd4 
              schema:
Packit Service 509fd4 
                $ref: '#/components/schemas/Error'
Packit Service 509fd4 
        5XX:
Packit Service 509fd4 
          description: ''
Packit Service 509fd4 
          content:
Packit Service 509fd4 
            application/json:
Packit Service 509fd4 
              schema:
Packit Service 509fd4 
                $ref: '#/components/schemas/Error'
Packit Service 509fd4 
      operationId: GetJob
Packit Service 509fd4 
      description: ''
Packit Service 509fd4 
    patch:
Packit Service 509fd4 
      summary: Update a running job
Packit Service 509fd4 
      tags: []
Packit Service 509fd4 
      responses: {}
Packit Service 509fd4 
      operationId: UpdateJob
Packit Service 509fd4 
      requestBody:
Packit Service 509fd4 
        content:
Packit Service 509fd4 
          application/json:
Packit Service 509fd4 
            schema:
Packit Service 509fd4 
              type: object
Packit Service 509fd4 
              properties:
Packit Service 509fd4 
                status:
Packit Service 509fd4 
                  type: string
Packit Service 509fd4 
                  enum:
Packit Service 509fd4 
                    - WAITING
Packit Service 509fd4 
                    - RUNNING
Packit Service 509fd4 
                    - FINISHED
Packit Service 509fd4 
                    - FAILED
Packit Service 509fd4 
                result: {}
Packit Service 509fd4 
              required:
Packit Service 509fd4 
                - status
Packit Service 509fd4 
                - result
Packit Service 509fd4 
  '/jobs/{token}/artifacts/{name}':
Packit Service 509fd4 
    parameters:
Packit Service 509fd4 
      - schema:
Packit Service 509fd4 
          type: string
Packit Service 509fd4 
        name: name
Packit Service 509fd4 
        in: path
Packit Service 509fd4 
        required: true
Packit Service 509fd4 
      - schema:
Packit Service 509fd4 
          type: string
Packit Service 509fd4 
        name: token
Packit Service 509fd4 
        in: path
Packit Service 509fd4 
        required: true
Packit Service 509fd4 
    put:
Packit Service 509fd4 
      summary: Upload an artifact
Packit Service 509fd4 
      tags: []
Packit Service 509fd4 
      responses:
Packit Service 509fd4 
        '200':
Packit Service 509fd4 
          description: OK
Packit Service 509fd4 
        4XX:
Packit Service 509fd4 
          content:
Packit Service 509fd4 
            application/json:
Packit Service 509fd4 
              schema:
Packit Service 509fd4 
                $ref: '#/components/schemas/Error'
Packit Service 509fd4 
        5XX:
Packit Service 509fd4 
          description: ''
Packit Service 509fd4 
          content:
Packit Service 509fd4 
            application/json:
Packit Service 509fd4 
              schema:
Packit Service 509fd4 
                $ref: '#/components/schemas/Error'
Packit Service 509fd4 
      operationId: UploadJobArtifact
Packit Service 509fd4 
      requestBody:
Packit Service 509fd4 
        content:
Packit Service 509fd4 
          application/octet-stream:
Packit Service 509fd4 
            schema:
Packit Service 509fd4 
              type: string
Packit Service 509fd4 
components:
Packit Service 509fd4 
  schemas:
Packit Service 509fd4 
    Error:
Packit Service 509fd4 
      title: Error
Packit Service 509fd4 
      type: object
Packit Service 509fd4 
      properties:
Packit Service 509fd4 
        message:
Packit Service 509fd4 
          type: string
Packit Service 509fd4 
      required:
Packit Service 509fd4 
        - message

Powered by Pagure 5.13.3

SSH Hostkey/Fingerprint | Documentation