swagger.yaml

openapi: 3.0.0
info:
  description: This swagger spec details the content and image functionality of
    the United Effects Platform. Copyright 2019 theBoEffect LLC. All rights
    reserved. https://unitedeffects.com
  version: 3.0.0
  title: UE Content Service
  contact:
    email: team@unitedeffects.com
tags:
  - name: logs
    description: Logging endpoints
  - name: Content
    description: CRUD for content
  - name: Images
    description: CRUD for images
paths:
  /logs:
    post:
      tags:
        - logs
      summary: Write a new log to the console and the db
      description: This is unlikely to be used with frequency.
      operationId: writeLog
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/Log"
        description: Log data to be written
        required: true
      responses:
        "200":
          description: successful operation
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiResponseLog"
        "401":
          description: Unauthorized
        "405":
          description: Invalid input
        "500":
          description: Unknown error
      security:
        - UEAuth:
            []
    get:
      tags:
        - logs
      summary: Retrieve all logs in the system
      description: ""
      operationId: getLogs
      responses:
        "200":
          description: successful operation
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Logs"
        "401":
          description: Unauthorized
      security:
        - UEAuth:
            []
  "/logs/{code}":
    get:
      tags:
        - logs
      summary: Find all logs with one type of code.
      description: Codes should be "error", "notify", or "success"
      operationId: getLogByCode
      parameters:
        - name: code
          in: path
          description: code of log types to return
          required: true
          schema:
            type: string
      responses:
        "200":
          description: successful operation
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Logs"
        "400":
          description: Invalid code supplied
        "401":
          description: Unauthorized
      security:
        - UEAuth:
            []
  "/logs/{code}/{timestamp}":
    get:
      tags:
        - logs
      summary: Find a log with code and timestamp specified
      description: Codes should be "error", "notify", or "success".
      operationId: getLog
      parameters:
        - name: code
          in: path
          description: code of log type to return
          required: true
          schema:
            type: string
        - name: timestamp
          in: path
          description: timestamp of log type to return
          required: true
          schema:
            type: string
            format: date-time
      responses:
        "200":
          description: successful operation
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiResponseLog"
        "400":
          description: Invalid code supplied
        "401":
          description: Unauthorized
        "404":
          description: Log not found
      security:
        - UEAuth:
            []
  /content:
    get:
      tags:
        - Content
      summary: Get All content entrys
      description: Get All content entrys
      parameters:
        - name: product
          in: query
          required: false
          description: product to categorize the content
          schema:
            type: string
        - name: domain
          in: query
          required: false
          description: domain to categorize the content
          schema:
            type: string
        - name: owner
          in: query
          required: false
          description: owner of the content you're looking for
          schema:
            type: string
        - name: search
          in: query
          required: false
          description: full text search
          schema:
            type: string
      responses:
        "200":
          description: successful operation
        "401":
          description: Unauthorized
        "405":
          description: Invalid input
        "500":
          description: Unknown error
      security:
        - UEAuth:
            []
    post:
      tags:
        - Content
      summary: Add a new content entry
      description: Add a new content entry
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/contentCreate"
        description: new content to be added
        required: true
      responses:
        "200":
          description: successful operation
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/singleResponseContent"
        "401":
          description: Unauthorized
        "405":
          description: Invalid input
        "500":
          description: Unknown error
      security:
        - UEAuth:
            []

  "/content/{guid}":
    get:
      tags:
        - Content
      summary: Get a content entry
      description: Get a content entry
      parameters:
        - name: guid
          in: path
          required: true
          description: Guid (or Slug) of the content
          schema:
            type: string
        - name: product
          in: query
          required: false
          description: product to categorize the content
          schema:
            type: string
        - name: domain
          in: query
          required: false
          description: domain to categorize the content
          schema:
            type: string
      responses:
        "200":
          description: successful operation
        "401":
          description: Unauthorized
        "405":
          description: Invalid input
        "500":
          description: Unknown error
      security:
        - UEAuth:
            []
    patch:
      tags:
        - Content
      summary: Edit a content entry
      description: Edit a content entry
      parameters:
        - name: guid
          in: path
          required: true
          description: Guid (or Slug) of content to retrieve
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/contentPatchObject"
        description: updates to content. Any of the following.
        required: true
      responses:
        "200":
          description: successful operation
        "401":
          description: Unauthorized
        "405":
          description: Invalid input
        "500":
          description: Unknown error
      security:
        - UEAuth:
            []
    delete:
      tags:
        - Content
      summary: Delete a content entry (hard delete)
      description: Delete a content (hard delete)
      parameters:
        - name: guid
          in: path
          required: true
          description: Guid of content to delete (ONLY GUID WORKS)
          schema:
            type: string
        - name: product
          in: query
          required: true
          description: product to categorize the content
          schema:
            type: string
        - name: domain
          in: query
          required: true
          description: domain to categorize the content
          schema:
            type: string
      responses:
        "200":
          description: successful operation
        "401":
          description: Unauthorized
        "405":
          description: Invalid input
        "500":
          description: Unknown error
      security:
        - UEAuth:
            []
  /image:
    post:
      tags:
        - Images
      summary: Add a new imgage
      description: Add a new image
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: "#/components/schemas/imageCreate"
      responses:
        "200":
          description: successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  type:
                    type: string
                    enum: [Image]
                  data:
                    $ref: "#/components/schemas/imageObject"
        "401":
          description: Unauthorized
        "405":
          description: Invalid input
        "500":
          description: Unknown error
      security:
        - UEAuth:
            []
  "/image/{guid}":
    get:
      tags:
        - Images
      summary: Get an image data
      description: Get an image data
      parameters:
        - name: guid
          in: path
          required: true
          description: Guid of image to retrieve
          schema:
            type: string
        - name: product
          in: query
          required: false
          description: product to categorize the image
          schema:
            type: string
        - name: domain
          in: query
          required: false
          description: domain to categorize the image
          schema:
            type: string
      responses:
        "200":
          description: successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  type:
                    type: string
                    enum: [Image]
                  data:
                    $ref: "#/components/schemas/imageObject"
        "401":
          description: Unauthorized
        "405":
          description: Invalid input
        "500":
          description: Unknown error
      security:
        - UEAuth:
            []
    patch:
      tags:
        - Images
      summary: Update an imgage data
      description: Update an image data
      parameters:
        - name: guid
          in: path
          required: true
          description: Guid of image to retrieve
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/imageObjectPatch"
        description: new image data to be added
        required: true
      responses:
        "200":
          description: successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  type:
                    type: string
                    enum: [Image]
                  data:
                    $ref: "#/components/schemas/imageObject"
        "401":
          description: Unauthorized
        "405":
          description: Invalid input
        "500":
          description: Unknown error
      security:
        - UEAuth:
            []
    delete:
      tags:
        - Images
      summary: Delete an image. Deletes from local db and from s3.
      description: Delete an image. Deletes from local db and from s3.
      parameters:
        - name: guid
          in: path
          required: true
          description: Guid of image to retrieve
          schema:
            type: string
        - name: product
          in: query
          required: true
          description: product to categorize the image
          schema:
            type: string
        - name: domain
          in: query
          required: true
          description: domain to categorize the image
          schema:
            type: string
      responses:
        "200":
          description: successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  type:
                    type: string
                    enum: [Image]
                  data:
                    $ref: "#/components/schemas/imageObject"
        "401":
          description: Unauthorized
        "405":
          description: Invalid input
        "500":
          description: Unknown error
      security:
        - UEAuth:
            []
  /images:
    get:
      tags:
        - Images
      summary: Get all images
      description: Get all images
      parameters:
        - name: product
          in: query
          required: false
          description: product to categorize the image
          schema:
            type: string
        - name: domain
          in: query
          required: false
          description: domain to categorize the image
          schema:
            type: string
        - name: owner
          in: query
          required: false
          description: owner of the image you're looking for
          schema:
            type: string
        - name: search
          in: query
          required: false
          description: full text search
          schema:
            type: string
      responses:
        "200":
          description: successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  type:
                    type: string
                    enum: [Images]
                  data:
                    type: array
                    items:
                      $ref: "#/components/schemas/imageObject"
        "401":
          description: Unauthorized
        "405":
          description: Invalid input
        "500":
          description: Unknown error
      security:
        - UEAuth:
            []
  "/img/{guid}":
    get:
      tags:
        - Images
      summary: Proxy to an image directly
      description: Proxy to an image directly
      parameters:
        - name: guid
          in: path
          required: true
          description: Guid of image to retrieve
          schema:
            type: string
      responses:
        "200":
          description: successful operation
        "401":
          description: Unauthorized
        "405":
          description: Invalid input
        "500":
          description: Unknown error
      security:
        - UEAuth:
            []
externalDocs:
  description: Secured by ueauth.io
  url: https://ueauth.io
servers:
  - url: http://localhost:3010/api
  - url: https://localhost:3010/api
components:
  securitySchemes:
    UEAuth:
      type: apiKey
      name: Authorization
      in: header
      description: For both UEAuth and other Bearer based tokens, type in "Bearer "
        followed by your Token.
  schemas:
    Log:
      type: object
      required:
        - logCode
        - logTimestamp
      properties:
        logCode:
          type: string
          description: This is your hashKey. This should only be ERROR, NOTIFY, or SUCCESS
        logTimestamp:
          type: string
          format: date-time
          description: This is your rangeKey. This is a timestamp.
        message:
          type: string
          description: This should be any brief summary data in string format.
        details:
          type: object
          description: You can directly pipe any error message objects to here.
    ApiResponseLog:
      properties:
        type:
          type: string
          enum:
            - Log
        data:
          $ref: "#/components/schemas/Log"
    Logs:
      properties:
        type:
          type: string
          enum:
            - Log
        data:
          type: array
          items:
            $ref: "#/components/schemas/Log"
    ApiResponse:
      type: object
      properties:
        code:
          type: integer
          format: int32
        type:
          type: string
        data:
          type: string
    contentPatchObject:
      properties:
        title:
          type: string
        content:
          type: string
        product:
          type: string
        domain:
          type: string
        tag:
          type: string
        active:
          type: boolean
          default: true
        internal_description:
          type: string
        auth_required:
          type: boolean
          default: false
    contentCreate:
      required:
        - title
        - product
        - domain
        - content
      additionalProperties: false
      properties:
        owner:
          type: string
          description: owner user id
        title:
          type: string
          description: brief title to identify the content
        product:
          type: string
          description: a product identifier to manage content
        domain:
          type: string
          description: a domain (within product) identifier to manage content
        labels:
          type: array
          description: descriptive labels/tags
          items:
            type: string
        content:
          type: string
          description: your actual content - could be anything as long as it passes as a string
        published:
          type: boolean
          description: if true, only owner can view
        authRequired:
          type: boolean
          description: if true, only logged in users can view, otherwise it is public to the internet
        internalDescription:
          type: string
          description: verbose description of the content
    singleResponseContent:
      properties:
        type:
          type: string
          enum: ['Content']
        data:
          $ref: "#/components/schemas/contentObject"
    contentObject:
      required:
        - owner
        - title
        - product
        - domain
        - content
      properties:
        created:
          type: string
          format: date-time
        guid:
          type: string
          description: unique id - auto generated
        owner:
          type: string
          description: owner user id
        title:
          type: string
          description: brief title to identify the content
        slug:
          type: string
          description: verbose identifier for query - auto generated
        product:
          type: string
          description: a product identifier to manage content
        domain:
          type: string
          description: a domain (within product) identifier to manage content
        labels:
          type: array
          description: descriptive labels/tags
          items:
            type: string
        content:
          type: string
          description: your actual content - could be anything as long as it passes as a string
        published:
          type: boolean
          description: if true, only owner can view
        authRequired:
          type: boolean
          description: if true, only logged in users can view, otherwise it is public to the internet
        internalDescription:
          type: string
          description: verbose description of the content
    imageCreate:
      type: object
      properties:
        file:
          type: string
          format: binary
        owner:
          type: string
        name:
          type: string
        description:
          type: string
        product:
          description: product to correlate image to
          type: string
        domain:
          description: domain to correlate image to
          type: string
        labels:
          type: array
          items:
            type: string
        authRequired:
          type: boolean
          default: false
        meta:
          type: object
      required:
        - file
        - name
        - description
        - product
        - domain
    imageObjectPatch:
      type: object
      additionalProperties: false
      properties:
        name:
          type: string
        description:
          type: string
        authRequired:
          type: boolean
        labels:
          type: array
          items:
            type: string
    imageObject:
      type: object
      properties:
        _id:
          type: string
          description: DB id
        guid:
          type: string
          description: external reference Id
        created:
          type: string
          format: date-time
        owner:
          type: string
        name:
          type: string
        description:
          type: string
        product:
          description: product to correlate image to
          type: string
        domain:
          description: domain to correlate image to
          type: string
        labels:
          type: array
          items:
            type: string
        authRequired:
          type: boolean
        url:
          type: string
          description: location of the image in s3
        meta:
          type: object