gem-spaas-coding-challenge/swagger.yml

consumes:
- application/eu.reverservices.gem.spaas.v1+json
info:
  description: This API exposes an algorithm that computes optimal power production
    allocation for a given power need and power plant capacity.
  title: Optimal power production allocation service
  version: 0.0.1
paths:
  /productionplan:
    post:
      summary: compute production plan
      consumes: 
        - application/json
      operationId: ProductionPlan
      parameters:
        - in: body
          name: payload format
          schema: 
            $ref: "#/definitions/payload"
      description: |
        Compute the optimal production plan for given load and capacity.
      produces:
        - application/json
      responses:
        200:
          description: returns optimal production plan
          schema:
            type: array
            items: 
              type: object
        default:
          description: generic error response
          schema:
            $ref: "#/definitions/error"
definitions:
  payload:
    type: object
    required:
      - load
      - fuels
      - powerplants
    properties:
      load:
        type: number
        format: float64
      fuels:
        type: object
      powerplants:
        type: array
        items: 
          $ref: "#/definitions/powerplant"
  powerplant:
    type: object
    required:
      - name
      - type
      - efficiency
      - pmin
      - pmax
    properties:
      name:
        type: string
      type:
        type: string
      efficiency:
        type: number
        format: float64
      pmin:
        type: number
        format: float64
      pmax:
        type: number
        format: float64
  error:
    type: object
    required:
      - message
    properties:
      code:
        type: integer
        format: int64
      message:
        type: string
produces:
- application/eu.reverservices.gem.spaas.v1+json
schemes:
- http
swagger: "2.0"