swagger.yaml

swagger: "2.0"
info:
  title: dp-sessions-api
  description: "API for Sessions"
  version: 1.0.0
  license:
    name: "Open Government Licence v3.0"
    url: "http://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/"
basePath: "/v1"
schemes:
  - http
tags:
  - name: "session"
paths:
  /sessions:
    post:
      security:
        - ServiceToken: [ ]
      tags:
        - session
      summary: Create a session endpoint
      description: Creates a new session for the provided user email.
      consumes:
        - application/json
      parameters:
        - in: body
          name: New session details
          description: Creates a new session for the provided user email.
          schema:
            $ref: "#/definitions/New%20Session%20Request"
      produces:
        - application/json
      responses:
        201:
          description: Created
          schema:
            $ref: "#/definitions/Session"
        400:
          description: Bad Request
        401:
          description: Unauthorized
        500:
          description: Internal Server Error
    delete:
      security:
        - ServiceToken: [ ]
      tags:
        - session
      summary: Delete all sessions
      description: Deletes all sessions from the cache
      produces:
        - application/json
      responses:
        200:
          description: OK
        400:
          description: Bad Request
        401:
          description: Unauthorized
        404:
          description: Not Found
  /sessions/{ID}:
    get:
      tags:
        - session
      summary: Get a session by ID endpoint
      description: Gets an existing session by the provided ID.
      parameters:
        - in: path
          name: ID
          type: string
          required: true
          description: ID of stored session
      produces:
        - application/json
      responses:
        200:
          description: OK
          schema:
            $ref: "#/definitions/Session"
        404:
          description: Not Found
        500:
          description: Internal Server Error
  /sessions/{Email}:
      get:
        tags:
          - session
        summary: Get a session by ID endpoint
        description: Gets an existing session by the provided ID.
        parameters:
          - in: path
            name: ID
            type: string
            required: true
            description: ID of stored session
        produces:
          - application/json
        responses:
          200:
            description: OK
            schema:
              $ref: "#/definitions/Session"
          404:
            description: Not Found
          500:
            description: Internal Server Error

securityDefinitions:
  ServiceToken:
    type: apiKey
    in: header
    name: service-token

definitions:
  New Session Request:
    type: object
    properties:
      email:
        type: string
        example: user@email.com
  Session:
    type: object
    properties:
      id:
        type: string
        example: 1234
      email:
        type: string
        example: user@email.com
      start:
        type: string
        example: "2006-01-02T15:04:05.000Z"
      lastAccessed:
        type: string
        example: "2006-01-02T15:04:05.000Z"