Leo1 Reversal Feature API

The Reversal Feature API from Leo1 — 2 operation(s) for reversal feature.

OpenAPI Specification

leo1-reversal-feature-api-openapi.yml Raw ↑
openapi: 3.0.2
info:
  title: leofees_backend api Reversal Feature API
  version: version
  description: General system endpoints for the API.
tags:
- name: Reversal Feature
paths:
  /api/v1/reversal/fee_collection:
    post:
      tags:
      - Reversal Feature
      summary: Reverse Fee Collection
      operationId: reverse_fee_collection_api_v1_reversal_fee_collection_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReverseFeeCollectionRequest'
        required: true
      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/reversal/student_waiver:
    post:
      tags:
      - Reversal Feature
      summary: Reverse Student Waiver
      operationId: reverse_student_waiver_api_v1_reversal_student_waiver_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReverseStudentWaiverRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - APIKeyHeader: []
components:
  schemas:
    ReverseFeeCollectionRequest:
      title: ReverseFeeCollectionRequest
      required:
      - student_id
      type: object
      properties:
        student_id:
          title: Student Id
          type: integer
          description: Student ID is required
        utrn:
          title: Utrn
          type: string
          description: utrn is optional
    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'
    ReverseStudentWaiverRequest:
      title: ReverseStudentWaiverRequest
      required:
      - student_id
      - waiver_id
      type: object
      properties:
        student_id:
          title: Student Id
          type: integer
          description: Student ID is required
        waiver_id:
          title: Waiver Id
          type: integer
          description: Waiver ID is required
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      in: header
      name: secret-key