Data-Intelligence-API

openapi: 3.0.0
# Added by API Auto Mocking Plugin
servers:
  - description: SwaggerHub API Auto Mocking
    url: https://virtserver.swaggerhub.com/mcculloh213/Data-Intelligence-API/1.0.0
info:
  description: 5915 Capstone Integration API
  version: "1.0.0"
  title: Data Intelligence Integration
  contact:
    email: pdevenpo@gmail.com
  license:
    name: Apache 2.0
    url: 'http://www.apache.org/licenses/LICENSE-2.0.html'
tags:
  - name: admins
    description: Secured Admin-only calls
  - name: developers
    description: Operations available to regular developers
  - name: public
    description: public tag
  - name: private
    description: private tag
  - name: AIML
    description: AIML Routes
  - name: AR
    description: AR Routes
  - name: Cognitive Learning
    description: Cognitive Learning Routes
  - name: IoT 
    description: IoT Routes
  - name: Search
    description: Semantic Search Routes
  - name: SSL
    description: SSL Provisioning Routes
paths:
  /conversation/{userId}:
    get:
      tags:
        - AIML
      summary: retrieves conversation thread by UserID
      operationId: searchUserID
      description:
        By specifying a UserID, you can retreive their conversation thread with the ChatBot
      parameters:
        - in: path
          name: userId
          description: Id of the User we wish to retreive the Conversation Thread From
          required: true
          schema:
            type: string
      responses:
        '200':
          description: 'search results matching criteria'
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/conversation'
        '400':
          description: 'Invalid input, object invalid.'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '401':
          description: 'Unauthorized to upload.'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '404':
          description: 'Requested Resource not Found.'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '500':
          description: "Server error"
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '415':
          description: 'File Type Not Allowed'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
      security:
        - user_auth:
          - "write:conversation"
          - "read:conversation"
            
  /conversation/{userId}/{conversationId}:
    get:
      tags:
        - AIML
      summary: retrieves conversation thread by ConversationId
      operationId: searchConversationId
      description: |
        By specifying a ConversationID, you can retreive their conversation thread with the ChatBot
      parameters:
        - in: path
          name: userId
          description: Id of the User we wish to retreive the Conversation Thread From
          required: true
          schema:
            type: string
        - in: path
          name: conversationId
          description: Id of the Conversation we wish to retreive the Conversation Thread From
          required: true
          schema:
            type: string
      responses:
        '200':
          description: 'search results matching criteria'
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/conversation'
        '400':
          description: 'Invalid input, object invalid.'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '401':
          description: 'Unauthorized to upload.'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '404':
          description: 'Requested Resource not Found.'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '500':
          description: "Server error"
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '415':
          description: 'File Type Not Allowed'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
      security:
        - user_auth:
          - "write:conversation"
          - "read:conversation"
    delete:
      tags:
        - AIML
      summary: Deletes a conversation thread
      description: Removes a specified conversation thread
      operationId: deleteThread
      parameters:
        - in: path
          name: userId
          description: Id of the User we wish to retreive the Conversation Thread From
          required: true
          schema:
            type: string
        - in: path
          name: conversationId
          description: Id of the Conversation we wish to retreive the Conversation Thread From
          required: true
          schema:
            type: string
      responses:
        '200':
          description: 'OK'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/conversation'
        '400':
          description: 'Invalid input, object invalid.'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '401':
          description: 'Unauthorized to upload.'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '404':
          description: 'Requested Resource not Found.'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '500':
          description: "Server error"
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '415':
          description: 'File Type Not Allowed'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
      security:
        - user_auth:
            - "write:conversation"
            - "read:conversation"
    put:
      tags:
        - AIML
      summary: Hide conversation thread
      description: Logged in User may hide a conversation thread.
      operationId: hideThread
      parameters:
        - in: path
          name: userId
          description: Id of the User we wish to retreive the Conversation Thread From
          required: true
          schema:
            type: string
        - in: path
          name: conversationId
          description: Id of the Conversation we wish to retreive the Conversation Thread From
          required: true
          schema:
            type: string
      responses:
        '200':
          description: 'OK'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/conversation'
        '400':
          description: 'Invalid input, object invalid.'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '401':
          description: 'Unauthorized to upload.'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '404':
          description: 'Requested Resource not Found.'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '500':
          description: "Server error"
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '415':
          description: 'File Type Not Allowed'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
      security:
        - user_auth:
            - "write:conversation"
            - "read:conversation"
  /conversation/{userId}/{conversationId}/{messageId}:
    get:
      tags:
        - AIML
      summary: retrieves message from conversation
      operationId: searchMessageID
      description: by specifying a message Id, it retrieves the message
      parameters:
        - in: path
          name: userId
          description: Id of the User we wish to retreive the Conversation Thread From
          required: true
          schema:
            type: string
        - in: path
          name: conversationId
          description: Id of the Conversation we wish to retreive the Conversation Thread From
          required: true
          schema:
            type: string
        - in: path
          name: messageId
          description: Id of the Message we wish to retreive the Conversation Thread From
          required: true
          schema:
            type: string
      responses:
        '200':
          description: 'search results matching criteria'
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/conversation'
        '400':
          description: 'Invalid input, object invalid.'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '401':
          description: 'Unauthorized to upload.'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '404':
          description: 'Requested Resource not Found.'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '500':
          description: "Server error"
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '415':
          description: 'File Type Not Allowed'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
      security:
        - user_auth:
            - "write:conversation"
            - "read:conversation"
    delete:
      tags:
        - AIML
      summary: Deletes a message from a Conversation 
      description: Removes a specified message from a specified thread
      operationId: deleteMessage
      parameters:
        - in: path
          name: userId
          description: Id of the User we wish to retreive the Conversation Thread From
          required: true
          schema:
            type: string
        - in: path
          name: conversationId
          description: Id of the Conversation we wish to retreive the Conversation Thread From
          required: true
          schema:
            type: string
        - in: path
          name: messageId
          description: Id of the Message we wish to retreive the Conversation Thread From
          required: true
          schema:
            type: string
      responses:
        '200':
          description: 'OK'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/conversation'
        '400':
          description: 'Invalid input, object invalid.'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '401':
          description: 'Unauthorized to upload.'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '404':
          description: 'Requested Resource not Found.'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '500':
          description: "Server error"
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '415':
          description: 'File Type Not Allowed'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
      security:
        - user_auth:
            - "write:conversation"
            - "read:conversation"
    put:
      tags:
        - AIML
      summary: Hide message in thread
      description: Logged in User may hide their message in a thread.
      operationId: hideThread
      parameters:
        - in: path
          name: userId
          description: Id of the User we wish to retreive the Conversation Thread From
          required: true
          schema:
            type: string
        - in: path
          name: conversationId
          description: Id of the Conversation we wish to retreive the Conversation Thread From
          required: true
          schema:
            type: string
        - in: path
          name: messageId
          description: Id of the Message we wish to retreive the Conversation Thread From
          required: true
          schema:
            type: string
      responses:
        '200':
          description: 'OK'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/conversation'
        '400':
          description: 'Invalid input, object invalid.'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '401':
          description: 'Unauthorized to upload.'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '404':
          description: 'Requested Resource not Found.'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '500':
          description: "Server error"
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '415':
          description: 'File Type Not Allowed'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
      security:
        - user_auth:
            - "write:conversation"
            - "read:conversation"
    post:
      tags:
        - AIML
      summary: posts message to conversation thread
      operationId: postMessage
      description: posts a provided string message to the conversation thread
      parameters:
        - in: path
          name: userId
          description: Id of the User we wish to retreive the Conversation Thread From
          required: true
          schema:
            type: string
        - in: path
          name: conversationId
          description: Id of the Conversation we wish to retreive the Conversation Thread From
          required: true
          schema:
            type: string
        - in: path
          name: messageId
          description: Id of the Message we wish to retreive the Conversation Thread From
          required: true
          schema:
            type: string
      responses:
        '200':
          description: 'OK'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/conversation'
        '400':
          description: 'Invalid input, object invalid.'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '401':
          description: 'Unauthorized to upload.'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '404':
          description: 'Requested Resource not Found.'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '500':
          description: "Server error"
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '415':
          description: 'File Type Not Allowed'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
      security:
        - user_auth:
            - "write:conversation"
            - "read:conversation"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/conversation'
        description: message to post
  /augmentedReality/{userId}/{imageTag}/{index}:
    get:
      tags:
        - AR
      summary: Retreives an Image at a specified index in an image set
      operationId: retrieveImageSet
      description: |
        Retrieve a specific image from the specified image set associated with a specified tag and user.
      parameters:
        - in: path
          name: imageTag
          description: A tag string used to describe an image.
          required: true
          schema:
            type: string
        - in: path
          name: userId
          description: A userID to pull image set from
          required: true
          schema:
            type: string
        - in: path
          name: index
          description: An index of an image to pull from image set
          required: true
          schema:
            type: integer
      responses:
        '200':
          description: 'Returning Image Object and Associated Tag'
          content:
            application/json:
              schema:
                type: object
                items:
                  $ref: '#/components/schemas/imageSet'
        '400':
          description: 'Invalid input, object invalid.'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '401':
          description: 'Unauthorized to upload.'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '404':
          description: 'Requested Resource not Found.'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '500':
          description: "Server error"
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '415':
          description: 'File Type Not Allowed'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
      security:
        - user_auth:
            - "read:conversation"
  /augmentedReality/{userId}/{imageTag}/{imageId}:
    post:
      tags:
        - AR
      summary: Posts an Image
      operationId: postImage
      description: | 
        Posts an Image to a database with a given Tag.
        **Access Policy**: Restricted
      parameters:
        - in: path
          name: imageTag
          description: The Image tag associated to image
          required: true
          schema:
            type: object
        - in: path
          name: imageId
          description: imageId to associate to image posted
          required: true
          schema:
            type: string
        - in: path
          name: userId
          description: The ID associated with User Posting the image.
          required: true
          schema:
            type: string
        - in: query
          name: image
          description: The Image to Publish
          required: true
          schema:
            type: string
            format: byte
      responses:
        '200':
          description: 'OK'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/imageSet'
        '400':
          description: 'Invalid input, object invalid.'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '401':
          description: 'Unauthorized to upload.'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '404':
          description: 'Requested Resource not Found.'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '500':
          description: "Server error"
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '415':
          description: 'File Type Not Allowed'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/image'
        description: image to post
      security:
        - user_auth:
            - "write:image"
            - "read:image"
  /augmentedReality/{userId}/{associatedModelTag}:
    get:
      tags:
        - AR
      summary: Retreives an Associated Model with Given Tag
      operationId: retrieveAssociatedModel
      description: |
        By specifying a Tag, an Associated Model will return.
      parameters:
        - in: path
          name: associatedModelTag
          description: A tag string used to describe an associated model.
          required: true
          schema:
            type: string
        - in: path
          name: userId
          description: A userID to pull associatedModel from
          required: true
          schema:
            type: string
      responses:
        '200':
          description: 'Returning Associated Model and Tag'
          content:
            application/json:
              schema:
                type: object
                items:
                  $ref: '#/components/schemas/associatedModel'
        '400':
          description: 'Invalid input, object invalid.'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '401':
          description: 'Unauthorized to upload.'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '404':
          description: 'Requested Resource not Found.'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '500':
          description: "Server error"
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '415':
          description: 'File Type Not Allowed'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
      security:
        - user_auth:
            - "read:conversation"
    post:
      tags:
        - AR
      summary: Post an Associated Model.
      operationId: postAssociatedModel
      description: | 
        Posts an associatedModel to a database with a given Tag.
        **Access Policy**: Restricted
      parameters:
        - in: path
          name: associatedModelTag
          description: The Associated Model's Tag to to associate with AM
          required: true
          schema:
            type: object
        - in: path
          name: userId
          description: user id of user posting model
          required: true
          schema:
            type: string
        - in: path
          name: associatedModelId
          description: id of associated Model
          required: true
          schema: 
            type: string
        - in: query
          name: associatedModel
          description: Associated Model
          required: true
          schema: 
            type: string
            format: byte
      responses:
        '200':
          description: 'OK'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/associatedModel'
        '201':
          description: 'Associated Model and Tag created'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/associatedModel'
        '204':
          description: 'Request Processed'
        '400':
          description: 'Invalid input, object invalid.'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '401':
          description: 'Unauthorized to upload.'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '404':
          description: 'Requested Resource not Found.'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '500':
          description: "Server error"
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '415':
          description: 'File Type Not Allowed'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/associatedModel'
        description: Associated Model to Post.
      security:
        - user_auth:
            - "write:image"
            - "read:image"
    put:
      tags:
        - AR
      summary: Updates Associated Model
      description: User may make changes to Associated Model.
      operationId: updateAssociatedModel
      parameters:
        - in: path
          name: associatedModelTag
          description: The Associated Model Id to publish
          required: true
          schema:
            type: object
        - in: path
          name: userId
          description: The userID of user posting image.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: 'OK'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/associatedModel'
        '400':
          description: 'Invalid input, object invalid.'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '401':
          description: 'Unauthorized to upload.'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '404':
          description: 'Requested Resource not Found.'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '500':
          description: "Server error"
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '415':
          description: 'File Type Not Allowed'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
      security:
        - user_auth:
            - "write:image"
            - "read:image"
    delete:
      tags:
        - AR
      summary: Deletes an associated model.
      description: | 
        Remove a specified associated model.
        **Access Policy**: Restricted
      operationId: deleteAssociatedModel
      parameters:
        - in: path
          name: associatedModelTag
          description: The associatedModelId tied to the model to delete.
          required: true
          schema:
            type: object
        - in: path
          name: userId
          description: The userID of user posting image.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: 'OK'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/associatedModel'
        '400':
          description: 'Invalid input, object invalid.'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '401':
          description: 'Unauthorized to upload.'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '404':
          description: 'Requested Resource not Found.'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '500':
          description: "Server error"
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '415':
          description: 'File Type Not Allowed'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
      security:
        - user_auth:
            - "write:image"
            - "read:image"
  /augmentedReality/{userId}/{associatedModelTag}/{index}:
    get:
      tags:
        - AR
      summary: Retreives an Associated Model with Given Tag at a specified index
      operationId: retrieveAssociatedModel
      description: |
        By specifying a Tag, an Associated Model will return.
      parameters:
        - in: path
          name: associatedModelTag
          description: A tag string used to describe an associated model.
          required: true
          schema:
            type: string
        - in: path
          name: userId
          description: A userID to pull associatedModel from
          required: true
          schema:
            type: string
        - in: path
          name: index
          description: an index of an associated model
          required: true
          schema: 
            type: integer
      responses:
        '200':
          description: 'Returning Associated Model and Tag'
          content:
            application/json:
              schema:
                type: object
                items:
                  $ref: '#/components/schemas/associatedModel'
        '400':
          description: 'Invalid input, object invalid.'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '401':
          description: 'Unauthorized to upload.'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '404':
          description: 'Requested Resource not Found.'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '500':
          description: "Server error"
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '415':
          description: 'File Type Not Allowed'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
      security:
        - user_auth:
            - "read:image"
  /augmentedReality/{userId}/{imageId}:
    delete:
      tags:
        - AR
      summary: Deletes an Image 
      description: | 
        Deletes an image from database with a given Tag.
        **Access Policy**: Restricted
      operationId: deleteImage
      parameters:
        - in: path
          name: imageId
          description: The image ID associated with the image to delete.
          required: true
          schema:
            type: object
        - in: path
          name: userId
          description: the user id of the user removing the image
          required: true
          schema:
            type: string
      responses:
        '200':
          description: 'OK'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/associatedModel'
        '400':
          description: 'Invalid input, object invalid.'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '401':
          description: 'Unauthorized to upload.'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '404':
          description: 'Requested Resource not Found.'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '500':
          description: "Server error"
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '415':
          description: 'File Type Not Allowed'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
      security:
        - user_auth:
            - "write:image"
            - "read:image"
  /image/{userId}/{imageTag}/{imageId}:
    post:
      tags:
        - Cognitive Learning
      summary: posts image 
      operationId: postImage
      description: posts a provided image
      parameters:
        - in: path
          name: imageTag
          description: The Image tag associated to image
          required: true
          schema:
            type: object
        - in: path
          name: imageId
          description: imageId to associate to image posted
          required: true
          schema:
            type: string
        - in: path
          name: userId
          description: The ID associated with User Posting the image.
          required: true
          schema:
            type: string
        - in: query
          name: image
          description: The Image to Publish
          required: true
          schema:
            type: string
            format: byte
      responses:
        '201':
          description: 'Image and Tag created'
        '204':
          description: 'Request Processed'
        '200':
          description: 'OK'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/image'
        '400':
          description: 'Invalid input, object invalid.'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '401':
          description: 'Unauthorized to upload.'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '404':
          description: 'Requested Resource not Found.'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '500':
          description: "Server error"
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '415':
          description: 'File Type Not Allowed'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
      security:
        - user_auth:
            - "write:image"
            - "read:image"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/image'
        description: image to post
        
  /dashboardWidgets/{userId}:
    get:
      tags:
        - IoT 
      summary: retrieves list of Dashboard Widgets
      operationId: widgetsUser
      description: |
        By specifying a UserID, you can retreive their Dashboard Widgets
      parameters:
        - in: path
          name: userId
          description: The ID associated with User retrieving Dashboard Widgets.
          required: true
          schema:
            type: string
        - in: query
          name: getWidgetsUser
          description: pass an userId to retrieve their Dashboard Widgets
          required: true
          schema:
            type: string
      responses:
        '200':
          description: 'search results matching criteria'
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/widgets'
        '400':
          description: 'Invalid input, object invalid.'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '401':
          description: 'Unauthorized to upload.'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '404':
          description: 'Requested Resource not Found.'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '500':
          description: "Server error"
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '415':
          description: 'File Type Not Allowed'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
      security:
        - user_auth:
            - "write:image"
            - "read:image"
  /dashboardWidgets/{widgetId}:
    get:
      tags:
        - IoT 
      summary: retrieves a Dashboard Widget
      operationId: widgetsId
      description: |
        By specifying a widgetId, you can retreive the Dashboard Widget
      parameters:
        - in: path
          name: widgetId
          description: The ID associated with widegts to be retrieved.
          required: true
          schema:
            type: string
        - in: query
          name: searchString
          description: pass a widgetId to retrieve the Dashboard Widget
          required: true
          schema:
            type: integer
            format: int32
            minimum: 0
      responses:
        '200':
          description: search results matching criteria
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/widgets'
        '400':
          description: bad input parameter
    post:
      tags:
        - IoT
      summary: Posts a Dashboard Widget 
      operationId: postWidget
      description: posts a provided Widget
      parameters:
      - in: path
        name: widgetId
        description: The ID associated with widegts to be retrieved.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: 'OK'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/widgets'
        '400':
          description: 'Invalid input, object invalid.'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '401':
          description: 'Unauthorized to upload.'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '404':
          description: 'Requested Resource not Found.'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '500':
          description: "Server error"
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '415':
          description: 'File Type Not Allowed'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
      security:
        - user_auth:
            - "write:image"
            - "read:image"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/widgets'
        description: Widget to post
    put:
      tags:
        - IoT
      summary: Updates a DashBoard Widget 
      description: User may make changes to current Dashboard Widget
      operationId: updateWidget
      parameters:
      - in: path
        name: widgetId
        description: The ID associated with widegts to be retrieved.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: 'OK'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/widgets'
        '400':
          description: 'Invalid input, object invalid.'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '401':
          description: 'Unauthorized to upload.'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '404':
          description: 'Requested Resource not Found.'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '500':
          description: "Server error"
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '415':
          description: 'File Type Not Allowed'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
      security:
        - user_auth:
            - "write:image"
            - "read:image"
    delete:
      tags:
        - IoT
      summary: Deletes an Dashboard Widget.
      description: Removes a specified Dashboard Widget.
      operationId: deleteDashboardWidget
      parameters:
      - in: path
        name: widgetId
        description: The ID associated with widegts to be retrieved.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: 'OK'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/widgets'
        '400':
          description: 'Invalid input, object invalid.'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '401':
          description: 'Unauthorized to upload.'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '404':
          description: 'Requested Resource not Found.'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '500':
          description: "Server error"
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '415':
          description: 'File Type Not Allowed'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
      security:
        - user_auth:
            - "write:image"
            - "read:image"
            
  /search:
    get:
      summary: obtains list of documents
      operationId: getDocuments
      tags: 
        - search
      description: |
        Obtain associated documents from a given organization.
      parameters:
        - name: organization 
          in: query
          description: organization to fetch documents from
          required: true
          schema:
            type: string
        - name: query
          in: query
          description: search query
          required: false
          schema:
            type: string
        - name: name
          in: query
          description: query document by name
          required: false
          schema: 
            type: string
      responses:
        '200':
          description: 'OK'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Document'
        '400':
          description: 'Invalid input, object invalid.'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '401':
          description: 'Unauthorized to upload.'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '404':
          description: 'Requested Resource not Found.'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '500':
          description: "Server error"
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '415':
          description: 'File Type Not Allowed'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
      security:
        - user_auth:
            - "write:image"
            - "read:image"
                
    post: 
      summary: upload document
      operationId: uploadDocument
      tags:
        - search
      parameters:
        - name: organization 
          in: query
          description: organization to upload documents to
          required: true
          schema:
            type: string
        - name: document
          in: header
          description: document to upload
          required: true
          schema:
            type: object
      responses:
        '200':
          description: 'OK'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Document'
        '400':
          description: 'Invalid input, object invalid.'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '401':
          description: 'Unauthorized to upload.'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '404':
          description: 'Requested Resource not Found.'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '500':
          description: "Server error"
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '415':
          description: 'File Type Not Allowed'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
      security:
        - user_auth:
            - "write:image"
            - "read:image"
          
  /documents/{documentId}:
    get:
      summary: obtain specific document
      operationId: getDocumentById
      tags:
        - search
      parameters:
        - name: documentId
          in: path
          required: true
          description: id of document to retrieve
          schema:
            type: string
        - name: organization 
          in: query
          description: organization to fetch documents from
          required: true
          schema:
            type: string
      responses:
        '200':
          description: 'OK'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Document'
        '400':
          description: 'Invalid input, object invalid.'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '401':
          description: 'Unauthorized to upload.'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '404':
          description: 'Requested Resource not Found.'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '500':
          description: "Server error"
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '415':
          description: 'File Type Not Allowed'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
      security:
        - user_auth:
            - "write:image"
            - "read:image"
    put:
      summary: update document
      operationId: updateDocument
      tags:
        - search
      parameters:
        - name: documentId
          in: path
          required: true
          description: id of document to retrieve
          schema:
            type: string
        - name: organization
          in: path
          description: organization to fetch documents from
          required: true
          schema:
            type: string
        - name: document
          in: query
          description: document
          required: true
          schema:
            $ref: "#/components/schemas/Document"
      responses:
        '200':
          description: 'OK'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Document'
        '400':
          description: 'Invalid input, object invalid.'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '401':
          description: 'Unauthorized to upload.'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '404':
          description: 'Requested Resource not Found.'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '500':
          description: "Server error"
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '415':
          description: 'File Type Not Allowed'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
      security:
        - user_auth:
            - "write:image"
            - "read:image"
          
    delete:
      summary: delete document
      operationId: deleteDocument
      tags:
        - search
      parameters:
        - name: documentId
          in: path
          required: true
          description: id of document to delete
          schema:
            type: string
        - name: organization
          in: path
          description: organization to fetch documents from
          required: true
          schema:
            type: string
      responses:
        '200':
          description: 'OK'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Document'
        '400':
          description: 'Invalid input, object invalid.'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '401':
          description: 'Unauthorized to upload.'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '404':
          description: 'Requested Resource not Found.'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '500':
          description: "Server error"
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '415':
          description: 'File Type Not Allowed'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
      security:
        - user_auth:
            - "write:image"
            - "read:image"
        
  /ssl/{userId}/{deviceId}:
    get:
      tags:
        - SSL
      summary: Retrieves a SSL Certificate, known as the public key
      operationId: retrieveSSL
      description: |
        Provides a SSL Certificate
      parameters:
        - in: path
          name: deviceId
          description: The ID associated with devices where user retrieves the SSL Certificate.
          required: true
          schema:
            type: string
        - in: path
          name: userId
          description: The ID associated with User retrieving a SSL Certificate.
          required: true
          schema:
            type: string
        - in: query
          name: getSSL
          description: providing userId and deviceId revieve the public key/cert
          required: false
          schema:
            type: string
      responses:
        '200':
          description: 'Returning Image Object and Associated Tag'
          content:
            application/json:
              schema:
                type: object
                items:
                  $ref: '#/components/schemas/ssl'
        '400':
          description: 'Invalid input, object invalid.'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '401':
          description: 'Unauthorized to upload.'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '404':
          description: 'Requested Resource not Found.'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '500':
          description: "Server error"
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '415':
          description: 'File Type Not Allowed'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
      security:
        - user_auth:
            - "write:image"
            - "read:image"
  
  /ssl/{publicKey}:
    get:
      tags:
        - SSL
      summary: Renews the SSL Certificate
      operationId: renewSSL
      description: |
        Renews a SSL Certificate
      parameters:
        - in: path
          name: publicKey
          description: The public key used by user to renew the SSL Certificate.
          required: true
          schema:
            type: string
        - in: query
          name: getSSL
          description: Providing the public key/cert, it renews the cert by returing it.
          required: false
          schema:
            type: string
      responses:
        '200':
          description: 'Returning Image Object and Associated Tag'
          content:
            application/json:
              schema:
                type: object
                items:
                  $ref: '#/components/schemas/ssl'
        '400':
          description: 'Invalid input, object invalid.'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '401':
          description: 'Unauthorized to upload.'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '404':
          description: 'Requested Resource not Found.'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '500':
          description: "Server error"
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
        '415':
          description: 'File Type Not Allowed'
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/genericErrorResponse'
      security:
        - user_auth:
            - "write:image"
            - "read:image"
          
components:
  schemas:
    conversation:
      required:
        - conversationId
        - date
        - users
      properties:
        conversationId:
          type: string
          example: ACME Corporation
        date:
          type: string
          example: 1-23-2020
        users:
          type: string
          example: ben
      type: object
    associatedModel:
      required:
        - modelId
        - modelName
        - associatedModel
      properties:
        modelId:
          type: string
          example: "123e4567-e89b-12d3-a456-426655440000"
        modelName:
          type: string
          example: Blue Ball
        associatedModel:
          type: string
          format: byte
      type: object
    image:
      required:
        - image
        - imageId
        - imageSetId
        - date
      properties:
        image:
          type: string
          format: byte
          example: Base64
        imageId:
          type: string
          example: "123e4567-e89b-12d3-a456-426655440000"
        imageSetId:
          type: string
          example: imageSet123456
          description: the image set the image is a part of
        date:
          type: string
          format: date
          example: 1-23-2020
      type: object
    imageSet:
      required:
        - imageSetId
        - imageSetName
      properties:
        imageSetId:
          type: string
          example: "123e4567-e89b-12d3-a456-426655440000"
        imageSetName:
          type: string
          example: pics_of_animals
      type: object
    Document:
      type: object
      required:
        - name
        - file
        - tags
      properties:
        id:
          type: string
          format: uuid
          example: d290f1ee-6c54-4b01-90e6-d701748f0851
        name:
          type: string
          example: Dog Picture
        file:
          type: string
          format: base64
        tags:
          type: array
          items:
            type: string
          example: ["Dog", "Puppy", "Test"]
    
    widgets:
      required:
        - userId
        - widgetId
      properties:
        userId:
          type: string
          example: name123456
        widgetId:
          type: integer
          example: 12345
      type: object
      
    Chart:
      type: object
      required:
        - id
        - userId
        - chart
        - payload
      properties:
        _id:
          type: string
          format: uuid
          example: '8b8da770-4e45-4d79-8cd8-a31aa82d5822'
        id:
          type: integer
          format: int64
          example: 42
        chart:
          $ref: '#/components/schemas/ChartType'
        options:
          $ref: '#/components/schemas/ChartOptions'
        payload:
          type: array
          items:
            $ref: '#/components/schemas/ChartData'
        userId:
          type: string
          example: '00uhzh7xycMLQvbFJ0h7'
          
    ChartAnchor:
      type: string
      enum:
        - AUTO
        - CENTER
        - CENTER_BOTTOM
        - CENTER_TOP
        - LEFT_BOTTOM
        - LEFT_CENTER
        - LEFT_TOP
        - RIGHT_BOTTOM
        - RIGHT_CENTER
        - RIGHT_TOP
        
    ChartAxis:
      type: object
      properties:
        labels:
          $ref: '#/components/schemas/ChartLabels'
        
    ChartData:
      type: object
      required:
        - label
        - value
      properties:
        label:
          type: string
          example: "Dexterity"
        value:
          type: array
          items: {}
          example: [12.5, "text", 0, 'f']
          
    ChartLabels:
      type: object
      properties:
        anchor:
          $ref: '#/components/schemas/ChartAnchor'
        fontColor:
          type: string
        fontDecoration:
          $ref: '#/components/schemas/FontDecoration'
        fontFamily:
          type: string
        format:
          type: string
        title:
          type: string
      
    ChartLegend:
      type: object
      
    ChartOptions:
      type: object
      properties:
        legend:
          $ref: '#/components/schemas/ChartLegend'
        padding:
          $ref: '#/components/schemas/ChartPadding'
        tooltop:
          $ref: '#/components/schemas/ChartTooltip'
        xAxis:
          type: array
          items:
            $ref: '#/components/schemas/ChartAxis'
        yAxis:
          type: array
          items:
            $ref: '#/components/schemas/ChartAxis'
        xScale:
          $ref: '#/components/schemas/ChartScaleX'
        yScale:
          $ref: '#/components/schemas/ChartScaleY'
    
    ChartPadding:
      type: object
        
    ChartScaleX:
      type: object
      
    ChartScaleY:
      type: object
        
    ChartTooltip:
      type: object
    
    ChartType:
      type: string
      enum:
        - BAR
        - BOX
        - BUBBLE
        - COLUMN
        - HEATMAP
        - LINE
        - PIE
        - RADAR
        - RANGE
        - SCATTER
        - VERTICAL
      example: 'RADAR'
      
    FontDecoration:
      type: string
      enum:
        - BLINK
        - LINE_THROUGH
        - NONE
        - OVERLINE
        - UNDERLINE 
    
    LabelOverlapMode:
      type: string
      enum:
        - ALLOW_OVERLAP
        - NO_OVERLAP
    
    Orientation:
      type: string
      enum:
        - BOTTOM
        - LEFT
        - RIGHT
        - TOP
    
    genericErrorResponse:
      type: "object"
      properties:
        err:
          type: "string"
          example: "An error has occurred while processing your request."
          description: "Basic error response."
    ssl:
      required:
        - userId
        - deviceId
        - publicKey
      properties:
        userId:
          type: string
          example: user123456
        deviceId:
          type: string
          example: computer123456
        publicKey:
          type: string
          example: 12Ce4tTus
      type: object