job-scopeId-jobId-steps.yaml

openapi: 3.0.2

info:
  title: Eclipse Kapua REST API - Jobs Steps
  version: '1.0'
  contact:
    name: Eclipse Kapua Dev Team
    url: https://eclipse.org/kapua
    email: kapua-dev@eclipse.org
  license:
    name: Eclipse Public License 2.0
    url: https://www.eclipse.org/legal/epl-2.0

paths:
  /{scopeId}/jobs/{jobId}/steps:
    get:
      tags:
        - Job - Step
      summary: Get all the Jobs Steps
      operationId: jobStepList
      parameters:
        - $ref: '../openapi.yaml#/components/parameters/scopeId'
        - $ref: '../job/job.yaml#/components/parameters/jobId'
        - $ref: '../openapi.yaml#/components/parameters/limit'
        - $ref: '../openapi.yaml#/components/parameters/offset'
      responses:
        200:
          description: The list of the Jobs available in the Scope
          content:
            application/json:
              schema:
                $ref: './jobStep.yaml#/components/schemas/jobStepListResult'
        401:
          $ref: '../openapi.yaml#/components/responses/unauthenticated'
        403:
          $ref: '../openapi.yaml#/components/responses/subjectUnauthorized'
        500:
          $ref: '../openapi.yaml#/components/responses/kapuaError'
    post:
      tags:
        - Job - Step
      summary: Create a new Job Step
      operationId: jobStepCreate
      parameters:
        - $ref: '../openapi.yaml#/components/parameters/scopeId'
      requestBody:
        description: An object containing the properties for the new Job Step to be created
        content:
          application/json:
            schema:
              $ref: './jobStep.yaml#/components/schemas/jobStepCreator'
        required: true
      responses:
        201:
          description: The Job Step that has just been created
          content:
            application/json:
              schema:
                $ref: './jobStep.yaml#/components/schemas/jobStep'
        401:
          $ref: '../openapi.yaml#/components/responses/unauthenticated'
        403:
          $ref: '../openapi.yaml#/components/responses/subjectUnauthorized'
        404:
          $ref: '../openapi.yaml#/components/responses/entityNotFound'
        500:
          $ref: '../openapi.yaml#/components/responses/kapuaError'
    delete:
      tags:
        - Job - Step
      summary: Delete a single Job Step
      operationId: jobStepDelete
      parameters:
        - $ref: '../openapi.yaml#/components/parameters/scopeId'
        - $ref: '../job/job.yaml#/components/parameters/jobId'
        - $ref: './jobStep.yaml#/components/parameters/stepId'
      responses:
        204:
          description: The Job Step has been deleted
        401:
          $ref: '../openapi.yaml#/components/responses/unauthenticated'
        403:
          $ref: '../openapi.yaml#/components/responses/subjectUnauthorized'
        404:
          $ref: '../openapi.yaml#/components/responses/entityNotFound'
        500:
          $ref: '../openapi.yaml#/components/responses/kapuaError'