OpenAPI Definitions.yaml

openapi: 3.0.0
info:
  title: FLUX-Coordinator
  description: This is the API documentation for the REST API of the Flux-Coordinator project.
  version: 0.0.2
  license:
    name: MIT
    url: "https://github.com/Flux-Coordinator/flux-frontend/blob/master/LICENSE"
servers:
  - url: https://flux-server-prod.herokuapp.com
    description: Production Server
  - url: https://flux-server-staging.herokuapp.com
    description: Staging Server
  - url: http://localhost:9000
    description: Development Server
tags:
- name: projects
  description: Everything that has to do with projects
- name: measurements
  description: Everything that has to do with measurements
- name: auth
  description: Authentication functionality
paths:
  /projects:
    get:
      summary: Get a list with all the projects
      description: Returns a list of all the available projects.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Project'
      tags:
        - projects
    post:
      summary: Create a new project
      description: Create a new project with the desired properties.
      requestBody:
        description: The parameters used to create a new project.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Project'
      responses:
        '201':
          description: Project was created successfully. Payload contains the location of the new project.
      tags:
        - projects
  /projects/{projectId}:
    get:
      summary: Get a single project
      description: Return a single project
      parameters:
        - name: projectId
          in: path
          required: true
          description: The database ID of the project you want to retrieve.
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Project'
        '204':
          description: Request was successful, but no project was found.
      tags:
        - projects
  /projects/{projectId}/rooms:
    get:
      summary: Get all the rooms in the project
      description: Get a list of all the available rooms in the corresponding project.
      parameters:
        - name: projectId
          in: path
          required: true
          description: The database ID of the project you are referring to.
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Room'
        '404':
          description: Project not found
      tags:
        - projects
    post:
      summary: Create a new room
      description: Create a new room inside an existing project.
      parameters:
        - name: projectId
          in: path
          required: true
          description: The database ID of the project that should contain the room.
          schema:
            type: string
      requestBody:
        description: The parameters used to create the new room.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Room'
      responses:
        '200':
          description: Room was created successfully
        '404':
          description: Project not found
      tags:
        - projects
  /projects/{projectId}/rooms/{roomId}:
    get:
      summary: Get a single room in the project
      description: Returns a single room with the ID corresponding to the roomId parameter.
      parameters:
        - name: projectId
          in: path
          required: true
          description: The database ID of the project you are referring to.
          schema:
            type: string
        - name: roomId
          in: path
          required: true
          description: The database ID of the room to get.
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                  $ref: '#/components/schemas/Room'
        '204':
          description: Project or Room not found
      tags:
        - projects
  /measurements/{measurementId}:
    get:
      summary: Get a single measurement
      description: Return a single measurement with the ID corresponding to the measurementId paramter.
      parameters:
        - name: measurementId
          in: path
          required: true
          description: The database ID of the measurement to get.
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MeasurementReadings'
        '204':
          description: Measurement not found.
        '400':
          description: Failed retrieving the measurement.s
      tags:
        - measurements
  /measurements/active/{measurementId}:
    put:
      summary: Place a new measurement as the active measurement.
      description: Set a new measurement as the currently active measurement. There can only be one active measurement.
      parameters:
        - name: measurementId
          in: path
          required: true
          description: The database ID of the measurement to set as active.
          schema:
            type: string
      responses:
        '200':
          description: OK
      tags:
        - measurements
  /measurements/active:
    delete:
      summary: Remove the currently active measurement
      description: Removes the currently active measurement from the active state. There will be no more currently active measurement, until it is set again.
      responses:
        '200':
          description: OK
      tags:
        - measurements
  /measurements/active/readings:
    post:
      summary: Add a reading to the active measurement
      description: Add new readings the currently active measurement.
      requestBody:
        description: The new readings that should get added to the measurement.
        required: true
        content:
          application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Reading'
      responses:
        '200':
          description: OK
      tags:
        - measurements
  /measurements:
    post:
      summary: Create a new measurement
      description: Create a new measurement with the desired properties.
      requestBody:
        description: The parameters used to create a new measurement.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MeasurementMetadata'
      responses:
        '200':
          description: Measurement was created successfully.
      tags:
        - measurements
  /auth/login:
    get:
      summary: Log user into the system
      description: The user is logged into the system
      parameters:
        - name: username
          in: query
          description: The username that should be logged in
          required: true
          schema:
            type: string
        - name: password
          in: query
          description: The password of the username trying to log in
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Logged in successfully.
      tags:
        - auth
  /auth/logout:
    get:
      summary: Log out the current user logged in the user session
      description: The user that's logged in, is stored in the session of the browser, which is sent to the server. The server-side session must be deleted to log out the user.
      responses:
        '200':
          description: Logged out successfully.
      tags:
        - auth
components:
  schemas:
    Project:
      type: object
      properties:
        projectId:
          type: string
        name:
          type: string
        description:
          type: string
        rooms:
          type: array
          items:
            $ref: '#/components/schemas/Room'
    Room:
      type: object
      properties:
        roomId:
          type: string
        name:
          type: string
        description:
          type: string
        floorPlan:
          type: string
        width:
          type: number
        length:
          type: number
        measurements:
          type: array
          items:
            $ref: '#/components/schemas/MeasurementMetadata'
    MeasurementMetadata:
      type: object
      properties:
        measurementId:
          type: string
        name:
          type: string
        description:
          type: string
        creator:
          type: string
        startDate:
          type: string
          format: date-time
        endDate:
          type: string
          format: date-time
        state:
          type: string
          enum: [done, running, ready]
        offset:
          type: number
        factor:
          type: number
    MeasurementReadings:
      type: object
      properties:
        measurementId:
          type: string
        anchorPositions:
          type: array
          items:
            $ref: '#/components/schemas/AnchorPosition'
        readings:
          type: array
          items:
            $ref: '#/components/schemas/Reading'
    AnchorPosition:
      type: object
      properties:
        anchorId:
          type: string
        name:
          type: string
        xPosition:
          type: number
        yPosition:
          type: number
        zPosition:
          type: number
    Reading:
      type: object
      properties:
        readingId:
          type: string
        luxValue:
          type: number
        xPosition:
          type: number
        yPosition:
          type: number
        zPosition:
          type: number
        timestamp:
          type: string
          format: date-time