seppen-swagger.yaml

swagger: "2.0"
info:
  description: "Simple distributed in-memory key-value store"
  version: "1.0.0"
  title: "Seppen"
host: "localhost:21285"
basePath: "/"
schemes:
- "http"
paths:
  /:
    get:
      summary: "Returns list of the keys"
      produces:
      - "application/octet-stream"
      responses:
        200:
          description: "ok"
          schema:
            type: "string"
            format: "binary"
  /{key}:
    parameters:
    - name: "key"
      in: "path"
      description: "key of the stored record"
      required: true
      type: "string"
    get:
      summary: "Return value for a given key"
      parameters:
      - in: "header"
        name: "If-None-Match"
        required: false
        type: "string"
      produces:
      - "application/octet-stream"
      responses:
        200:
          description: "ok"
          schema:
            type: "string"
            format: "binary"
        304:
          description: "not modified"
        404:
          description: "not found"
    put:
      summary: "Store given payload under a given key"
      parameters:
      - in: "body"
        name: "value"
        required: true
        schema:
          type: "string"
          format: "binary"
      produces:
      - "application/octet-stream"
      responses:
        201:
          description: "created"
        409:
          description: "conflict"
        500:
          description: "internal server error"
    delete:
      summary: "Delete record for a given key"
      produces:
      - "application/octet-stream"
      responses:
        204:
          description: "no content"
        500:
          description: "internal server error"