openapi: 3.2.0
info:
  title: Flyte Admin Launch Plans API
  description: The Flyte Admin API is the control-plane REST API exposed by the flyteadmin service.
  version: v1
  contact:
    name: Flyte
    url: https://flyte.org
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
servers:
- url: http://localhost:30080
  description: Default flyteadmin endpoint in a local sandbox cluster
tags:
- name: Launch Plans
  description: Launch plan registration, listing, retrieval, and activation.
paths:
  /api/v1/launch_plans:
    post:
      tags:
      - Launch Plans
      summary: Register a launch plan
      operationId: CreateLaunchPlan
      responses:
        '200':
          description: Launch plan registered.
  /api/v1/launch_plans/{id.project}/{id.domain}:
    get:
      tags:
      - Launch Plans
      summary: List launch plans
      operationId: ListLaunchPlans
      parameters:
      - name: id.project
        in: path
        required: true
        schema:
          type: string
      - name: id.domain
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: A list of launch plans.
  /api/v1/launch_plans/{id.project}/{id.domain}/{id.name}:
    get:
      tags:
      - Launch Plans
      summary: List launch plans for a name
      operationId: ListLaunchPlansByName
      parameters:
      - name: id.project
        in: path
        required: true
        schema:
          type: string
      - name: id.domain
        in: path
        required: true
        schema:
          type: string
      - name: id.name
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: A list of launch plans.
  /api/v1/launch_plans/{id.project}/{id.domain}/{id.name}/{id.version}:
    get:
      tags:
      - Launch Plans
      summary: Retrieve a launch plan
      operationId: GetLaunchPlan
      parameters:
      - name: id.project
        in: path
        required: true
        schema:
          type: string
      - name: id.domain
        in: path
        required: true
        schema:
          type: string
      - name: id.name
        in: path
        required: true
        schema:
          type: string
      - name: id.version
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: A launch plan entity.
    put:
      tags:
      - Launch Plans
      summary: Update launch plan state
      operationId: UpdateLaunchPlan
      parameters:
      - name: id.project
        in: path
        required: true
        schema:
          type: string
      - name: id.domain
        in: path
        required: true
        schema:
          type: string
      - name: id.name
        in: path
        required: true
        schema:
          type: string
      - name: id.version
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Launch plan updated.
  /api/v1/active_launch_plans/{project}/{domain}:
    get:
      tags:
      - Launch Plans
      summary: List active launch plans
      operationId: ListActiveLaunchPlans
      parameters:
      - name: project
        in: path
        required: true
        schema:
          type: string
      - name: domain
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: A list of active launch plans.
  /api/v1/active_launch_plans/{id.project}/{id.domain}/{id.name}:
    get:
      tags:
      - Launch Plans
      summary: Get the active launch plan for a name
      operationId: GetActiveLaunchPlan
      parameters:
      - name: id.project
        in: path
        required: true
        schema:
          type: string
      - name: id.domain
        in: path
        required: true
        schema:
          type: string
      - name: id.name
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The active launch plan.
  /api/v1/launch_plan_ids/{project}/{domain}:
    get:
      tags:
      - Launch Plans
      summary: List launch plan identifiers
      operationId: ListLaunchPlanIds
      parameters:
      - name: project
        in: path
        required: true
        schema:
          type: string
      - name: domain
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: A list of launch plan identifiers.