GitHub Raw JSON API

apache / airflow

46,457 Python

Apache Airflow - A platform to programmatically author, schedule, and monitor workflows

airflow Specification

Located in airflow-core/src/airflow/api_fastapi/auth/managers/simple/openapi/v2-simple-auth-manager-generated.yaml on branch HEAD

3.x (YAML) YAML 6.0 KB
Raw YAML Specification
openapi: 3.1.0
info:
  title: Simple auth manager sub application
  description: This is the simple auth manager fastapi sub application. This API is
    only available if the auth manager used in the Airflow environment is simple auth
    manager. This sub application provides the login form for users to log in.
  version: 0.1.0
paths:
  /auth/token:
    post:
      tags:
      - SimpleAuthManagerLogin
      summary: Create Token
      description: Authenticate the user.
      operationId: create_token
      parameters:
      - name: Content-Type
        in: header
        required: false
        schema:
          type: string
          description: Content-Type of the request body
          enum:
          - application/json
          - application/x-www-form-urlencoded
          default: application/json
          title: Content-Type
        description: Content-Type of the request body
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LoginResponse'
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPExceptionResponse'
          description: Bad Request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPExceptionResponse'
          description: Unauthorized
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPExceptionResponse'
          description: Unsupported Media Type
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LoginBody'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/LoginBody'
    get:
      tags:
      - SimpleAuthManagerLogin
      summary: Create Token All Admins
      description: Create a token with no credentials only if ``simple_auth_manager_all_admins``
        is True.
      operationId: create_token_all_admins
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LoginResponse'
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPExceptionResponse'
          description: Forbidden
  /auth/token/login:
    get:
      tags:
      - SimpleAuthManagerLogin
      summary: Login All Admins
      description: Login the user with no credentials.
      operationId: login_all_admins
      responses:
        '307':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPExceptionResponse'
  /auth/token/cli:
    post:
      tags:
      - SimpleAuthManagerLogin
      summary: Create Token Cli
      description: Authenticate the user for the CLI.
      operationId: create_token_cli
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LoginBody'
        required: true
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LoginResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPExceptionResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPExceptionResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    HTTPExceptionResponse:
      properties:
        detail:
          anyOf:
          - type: string
          - additionalProperties: true
            type: object
          title: Detail
      type: object
      required:
      - detail
      title: HTTPExceptionResponse
      description: HTTPException Model used for error response.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    LoginBody:
      properties:
        username:
          type: string
          title: Username
        password:
          type: string
          title: Password
      additionalProperties: false
      type: object
      required:
      - username
      - password
      title: LoginBody
      description: Login serializer for post bodies.
    LoginResponse:
      properties:
        access_token:
          type: string
          title: Access Token
      type: object
      required:
      - access_token
      title: LoginResponse
      description: Login serializer for responses.
    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