swaggerV3.yml

openapi: 3.0.1
info:
  title: Covid19 fighter API
  description: Covid19 fighter API description and specs
  version: 0.0.0
  x-logo:
    url: icon.png
    backgroundColor: '#FFFFFF'
    altText: Covid19 fighter Ai logo
servers:
  - url: 'http://localhost:4200/api'
security:
  - bearerAuth: []
paths:
  /submissions:
    get:
      description: The Submissions details api allows to visualize the details in list view
      operationId: details of Submissions
      parameters:
        - in: query
          name: disease_type
          schema:
            type: string
          description: Disease Type
        - in: query
          name: data_type
          schema:
            type: string
          description: Data type
        - in: query
          name: affiliation
          schema:
            type: string
          description: Affiliation
        - in: query
          name: created_at
          schema:
            type: string
          description: Creation date
        - in: query
          name: sortBy
          schema:
            type: string
          description: Sort field
        - in: query
          name: orderBy
          schema:
            type: string
          description: Order desc or asc
        - in: query
          name: limit
          schema:
            type: integer
          description: Submision per page
        - in: query
          name: skip
          schema:
            type: integer
          description: start index
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Submission'
  /submissions/list:
    get:
      description: The List Submissions api allows to visualize the details in list view
      operationId: List of Submissions
      parameters:
        - in: query
          name: disease_type
          schema:
            type: string
          description: Disease Type
        - in: query
          name: data_type
          schema:
            type: string
          description: Data type
        - in: query
          name: affiliation
          schema:
            type: string
          description: Affiliation
        - in: query
          name: created_at
          schema:
            type: string
          description: Creation date
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object

  /submissions/download:
    get:
      description: The List Submissions api allows to visualize the details in list view
      operationId: download a List of Submissions
      parameters:
        - in: query
          name: disease_type
          schema:
            type: string
          description: Disease Type
        - in: query
          name: data_type
          schema:
            type: string
          description: Data type
        - in: query
          name: affiliation
          schema:
            type: string
          description: Affiliation
        - in: query
          name: created_at
          schema:
            type: string
          description: Creation date
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: string
                format: binary
  /submissions/stat:
    get:
      description: The Submissions Statistics
      operationId: Statistics Submissions
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
  /submissions/mine:
    get:
      description: My Submissions api allows to visualize the details in list view
      operationId: My Submissions
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Submission'
    
  /submission:
    post:
      description: The Create Submission api
      operationId: Create Submission
      requestBody:
        content:
          multipart/form-data:
            schema:
              required:
                - data_type
                - disease_type
                - affiliation
                - files
              type: object
              properties:
                data_type:
                  type: string
                disease_type:
                  type: string
                description:
                  type: string
                affiliation:
                  type: string
                annotation:
                  type: object
                  properties: {}
                tags:
                  type: array
                  items:
                    type: string
                files:
                  type: array
                  items:
                    type: string
                    format: binary
        required: true
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                type: object
  '/submission/{id}':
    get:
      description: The Get Submission Details api allows to visualize the details
      operationId: Get Submission Details
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Submission'
    put:
      description: updateSubmission api
      operationId: Update Submission
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Submission'
        required: true
      responses:
        '200':
          description: ''
          content: {}
  /#:
    post:
      description: login user and Generate User Token api d
      operationId: login User
      requestBody:
        content:
          application/json:
            schema:
              required:
                - email
                - password
              type: object
              properties:
                email:
                  type: string
                password:
                  type: string
        required: true
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  token:
                    type: string
  /users:
    get:
      description: The User List api allows to visualize the details in list view
      operationId: List of Users
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/User'
  /user:
    get:
      description: The connected User api allows to visualize the connected user details
      operationId: Connected Users
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
    post:
      description: Register user and send confirmation email.
      operationId: Register User
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/User'
        required: true
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  token:
                    type: string
  '/user/{id}':
    get:
      description: The Get User Details api allows to visualize the details
      operationId: Get User Data
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Submission'
    put:
      description: Modify user data
      operationId: Modify user
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/User'
        required: true
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  token:
                    type: string
  '/confirmation/{token}':
    get:
      description: confirmation link
      parameters:
        - name: token
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: string
  /resetpasswrd:
    post:
      description: reset forgeten password
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                email:
                  type: string
              
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: string
  /storepasswrd:
    post:
      description: Store new password
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                userId:
                  type: string
                token:
                  type: string
                password:
                  type: string
              
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: string
  /tags:
    get:
      description: Get all tags
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
  /affiliations:
    get:
      description: Get all affiliations
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
  /predict:
    post:
      description: Store new password
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                tags:
                  type: array
                  items:
                    type: string
                file:
                  type: string
                  format: binary
                id_user:
                  type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  message:
                    type: string
                  Data:
                    $ref: '#/components/schemas/Prediction'
                  
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
  schemas:
    Submission:
      required:
        - affiliation
        - data_type
        - description
        - disease_type
      type: object
      properties:
        id:
          title: _id
          type: integer
          readOnly: true
        data_type:
          title: Data Type
          type: string
        disease_type:
          title: Disease Yype
          type: string
        description:
          title: Description
          type: string
        createdAt:
          title: Created timestamp
          type: number
        updatedAt:
          title: Updated timestamp
          type: number
        affiliation:
          title: Data Affiliation
          type: string
        upload_name:
          title: Upload Filename
          type: string
        annotation:
          title: image Annotation
          type: object
          properties: {}
        s3_path:
          title: Image path in AWS S3
          type: string
        tags:
          title: Data hashtags
          type: array
          items:
            type: string
        id_user:
            title: User Identifier
            type: string
    User:
      required:
        - email
        - username
      type: object
      properties:
        email:
          title: Email
          type: string
          format: email
        username:
          title: username
          type: string
        role:
          title: role
          type: string
        first_name:
          title: First name
          type: string
        last_name:
          title: Last name
          type: string
        affiliation:
          title: Data Affiliation
          type: string
    Prediction:
      type: object
      properties:
        id:
          title: _id
          type: integer
          readOnly: true
        predicted_class:
          title: Predicted Class
          type: string
        upload_name:
          title: Upload Filename
          type: string
        prediction_array:
          title: Prediction Array
          type: object
          properties: {}
        s3_path:
          title: Image path in AWS S3
          type: string
        tags:
          title: Data hashtags
          type: array
          items:
            type: string
        id_user:
            title: User Identifier
            type: string
        createdAt:
          title: Created timestamp
          type: number