openapi: 3.0.2
info:
  title: OpenEVSE WiFi API
  description: The API for the OpenEVSE WiFi module
  version: '1.0'
  contact:
    email: jeremy@bigjungle.net
    name: Jeremy Poulter
  license:
    name: Apache 2.0
    url: 'http://www.apache.org/licenses/LICENSE-2.0.html'
servers:
  - url: 'http://openevse.local/'
  - url: 'http://localhost:8080/'
paths:
  /status:
    get:
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: ./models/Status.yaml
  /config:
    get:
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: ./models/Config.yaml
              examples: {}
    post:
      responses:
        '200':
          description: OK
  /override:
    get:
      responses:
        '200':
          description: Manual overide is active
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Properties'
        '404':
          description: Manual overide is not active
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Message'
    post:
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Properties'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Message'
    patch:
      description: Toggle the manual override
      responses:
        '200':
          description: OK
    delete:
      description: Clears the manual override
      responses:
        '200':
          description: OK
  /claims:
    get:
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Claims'
  '/claims/{client}':
    get:
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Properties'
    post:
      description: Make/Update a claim
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Properties'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Message'
    delete:
      description: Release a claim
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Message'
  /schedule:
    get:
      summary: Get the current list of events
      description: This will get a complete list of events in the schedule
      responses:
        '200':
          description: List of the schedule events
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ScheduleEvent'
        '400':
          description: bad input parameter
    post:
      operationId: addInventory
      description: Adds an item to the system
      responses:
        '201':
          description: item created
        '400':
          description: 'invalid input, object invalid'
        '409':
          description: an existing item already exists
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScheduleEvent'
        description: Inventory item to add
  '/schedule/{id}':
    parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
        description: Numeric ID of the event
    get:
      summary: Get a specific event details
    post: null
    delete: null
components:
  schemas:
    Empty:
      title: Empty Schema
      type: object
    Properties:
      title: EVSE properties
      type: object
      properties:
        state:
          $ref: '#/components/schemas/EvseState'
        auto_release:
          type: boolean
          description: |
            `true` if the manual override is auto-released when the vehicle is
            disconnected, `false` if manual override will persist after vehicle
            disconnection.
    Message:
      title: Informational message
      type: object
      properties:
        msg:
          type: string
          description: The message
    Claim:
      title: EVSE claim
      allOf:
        - type: object
          properties:
            client:
              type: integer
              description: 'The client ID, defined by [OpenEVSE](https://github.com/OpenEVSE/ESP32_WiFi_V4.x/blob/master/src/evse_man.h#L25)'
            priority:
              type: integer
              description: 'The priority of the claim, the higher the number the higher the priority'
        - $ref: '#/components/schemas/Properties'
    Claims:
      title: List of EVSE claims
      type: array
      items:
        $ref: '#/components/schemas/Claim'
    EvseState:
      title: EVSE state
      type: string
      enum:
        - active
        - disabled
    ScheduleEvent:
      type: object
      required:
        - state
        - time
        - days
      properties:
        id:
          type: integer
          example: 1
        state:
          $ref: '#/components/schemas/EvseState'
        time:
          type: string
          format: time
        days:
          type: array
          items:
            $ref: '#/components/schemas/Day'
    Day:
      type: string
      enum:
        - monday
        - tuesday
        - wednesday
        - thursday
        - friday
        - saturday
        - sunday