Leo1 auth API

The auth API from Leo1 — 4 operation(s) for auth.

OpenAPI Specification

leo1-auth-api-openapi.yml Raw ↑
openapi: 3.0.2
info:
  title: leofees_backend api auth API
  version: version
  description: General system endpoints for the API.
tags:
- name: auth
paths:
  /api/v1/auth/login:
    post:
      tags:
      - auth
      summary: Get Status
      operationId: get_status_api_v1_auth_login_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Login'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LoginResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/auth/signup:
    post:
      tags:
      - auth
      summary: Signup
      operationId: signup_api_v1_auth_signup_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SignUp'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SignUpResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/user_journey/save:
    post:
      tags:
      - auth
      summary: Save User Journey Erp
      description: Save User journey from ERP
      operationId: save_user_journey_erp_api_v1_user_journey_save_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StudentERPRequest'
        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/institute:
    get:
      tags:
      - auth
      summary: Get Institute
      operationId: get_institute_api_v1_institute_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
components:
  schemas:
    SignUpResponse:
      title: SignUpResponse
      required:
      - status
      - message
      type: object
      properties:
        status:
          title: Status
          type: string
        message:
          title: Message
          type: string
        access_token:
          title: Access Token
          type: string
    PaymentType:
      title: PaymentType
      enum:
      - 1
      - 2
      description: An enumeration.
    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
    SignUp:
      title: SignUp
      required:
      - phone_number
      - otp
      type: object
      properties:
        phone_number:
          title: Phone Number
          type: string
        otp:
          title: Otp
          type: string
    StudentERPRequest:
      title: StudentERPRequest
      required:
      - student_name
      - roll_number
      - phone_number
      - institute_name
      - branch_name
      - course_name
      - fees_paid
      - total_fees
      - redirect_success
      - redirect_fail
      - uniquetransactionid
      - payment_type
      type: object
      properties:
        student_name:
          title: Student Name
          type: string
        roll_number:
          title: Roll Number
          type: string
        phone_number:
          title: Phone Number
          type: string
        institute_name:
          title: Institute Name
          type: string
        branch_name:
          title: Branch Name
          type: string
        course_name:
          title: Course Name
          type: string
        parent_name:
          title: Parent Name
          type: string
        fees_paid:
          title: Fees Paid
          type: number
        total_fees:
          title: Total Fees
          type: number
        redirect_success:
          title: Redirect Success
          type: string
        redirect_fail:
          title: Redirect Fail
          type: string
        uniquetransactionid:
          title: Uniquetransactionid
          type: string
        payment_type:
          $ref: '#/components/schemas/PaymentType'
        email:
          title: Email
          type: string
    HTTPValidationError:
      title: HTTPValidationError
      type: object
      properties:
        detail:
          title: Detail
          type: array
          items:
            $ref: '#/components/schemas/ValidationError'
    Login:
      title: Login
      required:
      - phone_number
      type: object
      properties:
        phone_number:
          title: Phone Number
          type: string
        otp:
          title: Otp
          type: string
    LoginResponse:
      title: LoginResponse
      required:
      - status
      - message
      - access_token
      type: object
      properties:
        status:
          title: Status
          type: string
        message:
          title: Message
          type: string
        access_token:
          title: Access Token
          type: string
        user_id:
          title: User Id
          type: string
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      in: header
      name: secret-key