openapi: 3.2.0
info:
  title: external/ingest/job_scheduler.proto Job Scheduler API
  version: version not set
tags:
- name: Job Scheduler
paths:
  /api/v0/retention/nodes/delete-nodes/config:
    post:
      operationId: JobScheduler_ConfigureDeleteNodesScheduler
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/chef.automate.api.ingest.response.ConfigureDeleteNodesScheduler'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/grpc.gateway.runtime.Error'
      tags:
      - Job Scheduler
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/chef.automate.api.ingest.request.SchedulerConfig'
        required: true
      summary: Job scheduler configure delete nodes scheduler
      x-summary-source: derived
  /api/v0/retention/nodes/missing-nodes-deletion/config:
    post:
      operationId: JobScheduler_ConfigureMissingNodesForDeletionScheduler
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/chef.automate.api.ingest.response.ConfigureMissingNodesForDeletionScheduler'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/grpc.gateway.runtime.Error'
      tags:
      - Job Scheduler
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/chef.automate.api.ingest.request.SchedulerConfig'
        required: true
      summary: Job scheduler configure missing nodes for deletion scheduler
      x-summary-source: derived
  /api/v0/retention/nodes/missing-nodes/config:
    post:
      operationId: JobScheduler_ConfigureNodesMissingScheduler
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/chef.automate.api.ingest.response.ConfigureNodesMissingScheduler'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/grpc.gateway.runtime.Error'
      tags:
      - Job Scheduler
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/chef.automate.api.ingest.request.SchedulerConfig'
        required: true
      summary: Job scheduler configure nodes missing scheduler
      x-summary-source: derived
  /api/v0/retention/nodes/status:
    get:
      operationId: JobScheduler_GetStatusJobScheduler
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/chef.automate.api.ingest.response.JobSchedulerStatus'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/grpc.gateway.runtime.Error'
      tags:
      - Job Scheduler
      summary: Job scheduler get status job scheduler
      x-summary-source: derived
components:
  schemas:
    chef.automate.api.ingest.response.Job:
      type: object
      properties:
        running:
          type: boolean
        name:
          type: string
        every:
          type: string
        last_run:
          type: string
        next_run:
          type: string
        last_elapsed:
          type: string
        started_on:
          type: string
        threshold:
          type: string
    grpc.gateway.runtime.Error:
      type: object
      properties:
        error:
          type: string
        code:
          type: integer
          format: int32
        message:
          type: string
        details:
          type: array
          items:
            $ref: '#/components/schemas/google.protobuf.Any'
    chef.automate.api.ingest.request.SchedulerConfig:
      type: object
      properties:
        every:
          type: string
        threshold:
          type: string
        running:
          type: boolean
      description: 'SchedulerConfig

        The job message to configure the Delete Node Job

        every - It accepts ''1h30m'', ''1m'', ''2h30m'', ...'
    chef.automate.api.ingest.response.ConfigureNodesMissingScheduler:
      type: object
    chef.automate.api.ingest.response.ConfigureMissingNodesForDeletionScheduler:
      type: object
    chef.automate.api.ingest.response.ConfigureDeleteNodesScheduler:
      type: object
    google.protobuf.Any:
      type: object
      properties:
        type_url:
          type: string
        value:
          type: string
          format: byte
    chef.automate.api.ingest.response.JobSchedulerStatus:
      type: object
      properties:
        running:
          type: boolean
        jobs:
          type: array
          items:
            $ref: '#/components/schemas/chef.automate.api.ingest.response.Job'