swagger.yml

openapi: 3.0.3
info:
  title: Mtx Key-Store DB
  description: A persistent key value store with usage analytics
  version: 1.0.0
servers:
  - url: 'http://localhost:8080'
paths:
  /kvstore/savekv:
    post:
      summary: Store a key/value pair
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                key:
                  type: string
                value:
                  type: string
              required:
                - key
                - value
      parameters:
        - name: Authorization
          in: header
          required: true
      responses:
        '200':
          description: Successfully saved new key/value pair
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
        '201':
          description: Successfully saved new value under existing key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
        '400':
          description: Invalid request
        '422':
          description: Field exceeds max length
        '401':
          description: Missing authentication header
        '403':
          description: Invalid authentication header
  /kvstore/getkv:
    get:
      summary: Get a value given a key
      parameters:
        - name: key
          in: query
          required: true
          schema:
            type: string
        - name: Authorization
          in: header
          required: true
      responses:
        '200':
          description: Value found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
        '400':
          description: Missing key parameter
        '404':
          description: No value found under given key
        '401':
          description: Missing authentication header
        '403':
          description: Invalid authentication header
  /kvstore/deletekv:
    delete:
      summary: Delete a value given a key
      parameters:
        - name: key
          in: query
          required: true
          schema:
            type: string
        - name: Authorization
          in: header
          required: true
      responses:
        '200':
          description: Value deleted. Old value returned, or null if none existed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
        '400':
          description: Missing key parameter
        '401':
          description: Missing authentication header
        '403':
          description: Invalid authentication header

  /urlshortner/saveurl:
    post:
      summary: Store a url/name pair
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                url:
                  type: string
                name:
                  type: string
              required:
                - url
      parameters:
        - name: Authorization
          in: header
          required: true
      responses:
        '201':
          description: Successfully saved new url/name pair
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
        '400':
          description: Invalid request
        '422':
          description: Field invalid or exceeds max length
        '426':
          description: Url Shortener disabled in app config
        '401':
          description: Missing authentication header
        '403':
          description: Invalid authentication header
        '503':
          description: Cooldown is still active and prevented the action
  /urlshortener/geturl:
    get:
      summary: Get a url given a name
      parameters:
        - name: name
          in: query
          required: true
          schema:
            type: string
        - name: Authorization
          in: header
          required: true
      responses:
        '200':
          description: Url found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
        '400':
          description: Missing name parameter
        '404':
          description: No url found with given name
        '422':
          description: Param exceeds max length
        '426':
          description: Url Shortener disabled in app config
        '401':
          description: Missing authentication header
        '403':
          description: Invalid authentication header
  /urlshortener/gotourl:
    get:
      summary: Redirect to a url given a name
      parameters:
        - name: name
          in: query
          required: true
          schema:
            type: string
        - name: Authorization
          in: header
          required: true
      responses:
        '303':
          description: Url found
        '400':
          description: Missing name parameter
        '404':
          description: No url found with given name
        '426':
          description: Url Shortener disabled in app config
        '401':
          description: Missing authentication header
        '403':
          description: Invalid authentication header
  /urlshortener/getallurls:
    get:
      summary: Get all saved urls
      parameters:
        - name: batchSize
          in: query
          description: number of results to return
          schema:
            type: integer
        - name: offset
          in: query
          description: index to start returning results from
          schema:
            type: integer
        - name: Authorization
          in: header
          required: true
      responses:
        '200':
          description: Urls loaded and returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
        '400':
          description: Missing a parameter
        '404':
          description: No url found with given name
        '422':
          description: Invalid parameter
        '426':
          description: Url Shortener disabled in app config
        '401':
          description: Missing authentication header
        '403':
          description: Invalid authentication header

  /stats:
    get:
      summary: Get information about the app and api usages
      parameters:
        - name: Authorization
          in: header
          required: true
      responses:
        '200':
          description: All available app data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
        '401':
          description: Missing authentication header
        '403':
          description: Invalid authentication header
        '501':
          description: Stats disabled in app config


components:
  schemas:
    ApiResponse:
      type: object
      properties:
        requestUri:
          type: string
          description: URI sent to the server that led you here
        message:
          type: string
          description: Message from the server in response
        status:
          type: integer
          format: int32
          description: HTTP status code
        timestamp:
          type: string
          format: date-time
          description: Timestamp of when this response was generated
        body:
          type: object
          description: Response content
      required:
        - requestUri
        - message
        - status
        - timestamp