RunWhen codebundles API

The codebundles API from RunWhen — 1 operation(s) for codebundles.

OpenAPI Specification

runwhen-codebundles-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: papi alert-query-proxy codebundles API
  description: RunWhen Platform API
  version: 2.0.0
tags:
- name: codebundles
paths:
  /api/v3/parsecodebundle:
    get:
      tags:
      - codebundles
      summary: Parse Codebundle
      description: 'Parse a code bundle and return its tasks, config schema, and metadata.


        Used by the corestate runbook controller to populate

        ``status.codeBundle.tasks`` on Runbook CRDs.'
      operationId: parse_codebundle_api_v3_parsecodebundle_get
      parameters:
      - name: repoUrl
        in: query
        required: true
        schema:
          type: string
          title: Repourl
      - name: ref
        in: query
        required: true
        schema:
          type: string
          title: Ref
      - name: pathToRobot
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Pathtorobot
      - name: pathToYaml
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Pathtoyaml
      - name: pathInRepo
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Pathinrepo
      - name: obo
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Obo
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Parse Codebundle Api V3 Parsecodebundle Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - BearerAuth: []
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT access token from /api/v3/token/ or Auth0 login