Leo1 user API

The user API from Leo1 — 2 operation(s) for user.

OpenAPI Specification

leo1-user-api-openapi.yml Raw ↑
openapi: 3.0.2
info:
  title: leofees_backend api user API
  version: version
  description: General system endpoints for the API.
tags:
- name: user
paths:
  /api/v1/user/details:
    get:
      tags:
      - user
      summary: Get User Details
      operationId: get_user_details_api_v1_user_details_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserDetailResponse'
  /api/v1/user/update_user:
    post:
      tags:
      - user
      summary: Update User Details
      operationId: update_user_details_api_v1_user_update_user_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/updateUser'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreatedResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    CreatedResponse:
      title: CreatedResponse
      required:
      - created
      - status
      type: object
      properties:
        created:
          title: Created
          type: boolean
        status:
          title: Status
          type: string
    updateUser:
      title: updateUser
      required:
      - phone_number
      - name
      type: object
      properties:
        phone_number:
          title: Phone Number
          type: string
        name:
          title: Name
          type: string
    UserDetailResponse:
      title: UserDetailResponse
      required:
      - id
      - phone_number
      type: object
      properties:
        id:
          title: Id
          type: integer
        email:
          title: Email
          type: string
        phone_number:
          title: Phone Number
          type: string
        tenant_type:
          title: Tenant Type
          type: string
        name:
          title: Name
          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
    HTTPValidationError:
      title: HTTPValidationError
      type: object
      properties:
        detail:
          title: Detail
          type: array
          items:
            $ref: '#/components/schemas/ValidationError'
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      in: header
      name: secret-key