zGrid-api/docs/openapi.yaml

openapi: 3.0.4
info:
  title: API Documentation | Homo
  version: 1.0.0
  description: API for Homo, home automation software

servers:
  - url: http://0.0.0.0:9123
    description: Development/local server

tags:
  - name: User
  - name: Home
  - name: Device

components:
  schemas:
    User:
      $ref: "./components/schemas/user.yaml"
    Home:
      $ref: "./components/schemas/home.yaml"
    Device:
      $ref: "./components/schemas/device.yaml"
  responses:
    "400":
      $ref: "./components/responses/400.yaml"
    "401":
      $ref: "./components/responses/401.yaml"
    "403":
      $ref: "./components/responses/403.yaml"
    "404":
      $ref: "./components/responses/404.yaml"
    "500":
      $ref: "./components/responses/500.yaml"
  securitySchemes:
    $ref: "./components/security.yaml"

paths:
  #Users
  /user:
    post:
      $ref: "./paths/user/create.yaml"
    get:
      $ref: "./paths/user/get_one.yaml"
  /user/login:
    post:
      $ref: "./paths/user/login.yaml"
  /user/logout:
    post:
      $ref: "./paths/user/logout.yaml"
  /user/password/reset:
    patch:
      $ref: "./paths/user/reset_password.yaml"

  #Homes
  /home:
    post:
      $ref: "./paths/home/create.yaml"
    get:
      $ref: "./paths/home/get_many.yaml"
  /home/{home_id}:
    delete:
      $ref: "./paths/home/delete.yaml"
  /home/{home_id}/apikey/:
    post:
      $ref: "./paths/home/rotate_key.yaml"

  #Devices
  /home/{home_id}/device:
    post:
      $ref: "./paths/device/create.yaml"
    get:
      $ref: "./paths/device/get_many.yaml"
  /home/{home_id}/device/{device_id}:
    delete: 
      $ref: "./paths/device/delete.yaml"
  /home/{home_id}?device/{device_id}/signal:
    post:
      $ref: "./paths/device/signal.yaml"