Leo1 api API

General system endpoints for the API.

OpenAPI Specification

leo1-api-api-openapi.yml Raw ↑
openapi: 3.0.2
info:
  title: leofees_backend api API
  version: version
  description: General system endpoints for the API.
tags:
- name: api
  description: General system endpoints for the API.
paths:
  /api/v1/status:
    get:
      tags:
      - api
      summary: Get Status
      description: Get API status.
      operationId: get_status_api_v1_status_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
  /api/v1/auth/get_otp:
    post:
      tags:
      - api
      summary: Send Otp
      description: Get OTP
      operationId: send_OTP_api_v1_auth_get_otp_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/triggerSMSBody'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/auth/get_otp_signup:
    post:
      tags:
      - api
      summary: Send Otp Signup
      description: Get OTP
      operationId: send_otp_signup_api_v1_auth_get_otp_signup_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/triggerSMSBody'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/error:
    get:
      tags:
      - api
      summary: Error Func
      operationId: error_func_api_v1_error_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
components:
  schemas:
    HTTPValidationError:
      title: HTTPValidationError
      type: object
      properties:
        detail:
          title: Detail
          type: array
          items:
            $ref: '#/components/schemas/ValidationError'
    triggerSMSBody:
      title: triggerSMSBody
      required:
      - mobile
      type: object
      properties:
        mobile:
          title: Mobile
          type: string
    ValidationError:
      title: ValidationError
      required:
      - loc
      - msg
      - type
      type: object
      properties:
        loc:
          title: Location
          type: array
          items:
            anyOf:
            - type: string
            - type: integer
        msg:
          title: Message
          type: string
        type:
          title: Error Type
          type: string
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      in: header
      name: secret-key