Leo1 documents API

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

OpenAPI Specification

leo1-documents-api-openapi.yml Raw ↑
openapi: 3.0.2
info:
  title: leofees_backend api documents API
  version: version
  description: General system endpoints for the API.
tags:
- name: documents
paths:
  /api/v1/documents/:
    get:
      tags:
      - documents
      summary: Get Document
      operationId: get_document_api_v1_documents__get
      parameters:
      - required: true
        schema:
          title: Document Id
          type: integer
        name: document_id
        in: query
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - APIKeyHeader: []
  /api/v1/documents/response_file_manager:
    get:
      tags:
      - documents
      summary: Get Response File Manager Data
      operationId: get_response_file_manager_data_api_v1_documents_response_file_manager_get
      parameters:
      - required: true
        schema:
          title: Institutes
          type: string
        name: institutes
        in: query
      - required: false
        schema:
          title: Branches
          type: string
          default: ''
        name: branches
        in: query
      - required: false
        schema:
          title: Limit
          type: integer
        name: limit
        in: query
      - required: false
        schema:
          title: Offset
          type: integer
        name: offset
        in: query
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - APIKeyHeader: []
  /api/v1/documents/download/response_file_manager:
    get:
      tags:
      - documents
      summary: Download Response File Manager
      operationId: download_response_file_manager_api_v1_documents_download_response_file_manager_get
      parameters:
      - required: true
        schema:
          title: File Manager Id
          type: integer
        name: file_manager_id
        in: query
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - APIKeyHeader: []
  /api/v1/documents/delete/expired_file_manager_records:
    delete:
      tags:
      - documents
      summary: Delete Expired File Manager Records
      operationId: delete_expired_file_manager_records_api_v1_documents_delete_expired_file_manager_records_delete
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
      security:
      - APIKeyHeader: []
components:
  schemas:
    HTTPValidationError:
      title: HTTPValidationError
      type: object
      properties:
        detail:
          title: Detail
          type: array
          items:
            $ref: '#/components/schemas/ValidationError'
    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