openapi: 3.1.0
info:
  title: Apache Flink REST Checkpoints JARs API
  description: The Flink REST API is exposed by the JobManager Dispatcher and provides monitoring and management capabilities for a Flink cluster. It covers cluster configuration, JobManager environment and metrics, job lifecycle (submit, list, cancel, stop), checkpoint and savepoint management, JAR upload and execution, dataset operations, and TaskManager inspection.
  version: v1
  contact:
    name: Apache Flink
    url: https://flink.apache.org/community/
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
servers:
- url: http://localhost:8081
  description: Default JobManager Dispatcher endpoint
tags:
- name: JARs
  description: JAR upload, listing, run, and delete.
paths:
  /jars:
    get:
      tags:
      - JARs
      summary: List uploaded JARs
      operationId: listJars
      responses:
        '200':
          description: Uploaded JARs available for execution.
  /jars/upload:
    post:
      tags:
      - JARs
      summary: Upload a JAR
      operationId: uploadJar
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                jarfile:
                  type: string
                  format: binary
      responses:
        '200':
          description: JAR uploaded successfully.
  /jars/{jarid}:
    delete:
      tags:
      - JARs
      summary: Delete a JAR
      operationId: deleteJar
      parameters:
      - in: path
        name: jarid
        required: true
        schema:
          type: string
      responses:
        '200':
          description: JAR deleted.
  /jars/{jarid}/plan:
    get:
      tags:
      - JARs
      summary: Plan for a JAR
      operationId: getJarPlan
      parameters:
      - in: path
        name: jarid
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Dataflow plan for the JAR.
  /jars/{jarid}/run:
    post:
      tags:
      - JARs
      summary: Run a job from a JAR
      operationId: runJar
      parameters:
      - in: path
        name: jarid
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Job submitted from the JAR.