openapi: 3.0.0
info:
  title: Labguru Antibodies Maintenances API
  description: "Labguru API is a JSON / REST based API, get started by reviewing the documentation below or code samples.<br>\n        Join our dedicated [Slack channel](https://join.slack.com/t/labgurus/shared_invite/zt-199glfagl-QZQ_bKl7vLAi8CQSuNrRug)\n        to be in direct contact with our API team and be informed about the latest updates.<br>\n        ***[API introduction and overview](https://help.labguru.com/en/articles/6149483-api-introduction-and-overview)***"
  version: v1
tags:
- name: Maintenances
paths:
  /api/v1/maintenances:
    post:
      summary: Add maintenance to equipment
      tags:
      - Maintenances
      parameters: []
      responses:
        '201':
          description: maintenance created
        '401':
          description: invalid request
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/createMaintenance'
        required: true
    get:
      summary: List all maintenances in your account
      tags:
      - Maintenances
      parameters:
      - name: token
        in: query
        required: true
        schema:
          type: string
      - name: page
        in: query
        description: the default call is with page = 1
        schema:
          type: integer
      - name: meta
        in: query
        description: ' show summarized data information - true/false'
        schema:
          type: string
      responses:
        '200':
          description: success
        '404':
          description: page not found
  /api/v1/maintenances/{id}:
    put:
      summary: Update maintenance of equipment
      tags:
      - Maintenances
      parameters:
      - name: id
        in: path
        required: true
        description: maintenance id
        schema:
          type: integer
      responses:
        '200':
          description: maintenance updated
        '401':
          description: 'Error: Unauthorized'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/updateMaintenance'
        required: true
    get:
      summary: Get maintenances by id
      tags:
      - Maintenances
      parameters:
      - name: token
        in: query
        required: true
        schema:
          type: string
      - name: id
        in: path
        required: true
        description: maintenance id
        schema:
          type: integer
      responses:
        '200':
          description: success
        '404':
          description: maintenance not found
    delete:
      summary: Delete maintenance
      tags:
      - Maintenances
      parameters:
      - name: token
        in: query
        required: true
        schema:
          type: string
      - name: id
        in: path
        required: true
        description: maintenance id
        schema:
          type: integer
      responses:
        '204':
          description: no content
        '404':
          description: not found
components:
  schemas:
    createMaintenance:
      type: object
      required:
      - token
      properties:
        token:
          type: string
          example: YOUR TOKEN IS HERE
        item:
          type: object
          required:
          - item_id
          - item_type
          - maintenance_type_id
          - frequency_period
          - frequency_frame
          properties:
            item_id:
              type: integer
              description: The ID of the equipment
            item_type:
              type: string
              description: the class of the item (System::Instrument)
              example: System::Instrument
            maintenance_type_id:
              type: integer
              description: The ID of the maintenance type
            frequency_period:
              type: integer
              description: the time period in numbers
              example: '1'
            frequency_frame:
              type: string
              description: one of the following time frames - hour/day/week/month/year
              example: year
    updateMaintenance:
      type: object
      required:
      - token
      properties:
        token:
          type: string
          example: YOUR TOKEN IS HERE
        item:
          type: object
          required:
          - item_id
          properties:
            item_id:
              type: integer
              description: The ID of the equipment
            frequency_period:
              type: integer
              description: the time period in numbers
              example: '15'
            frequency_frame:
              type: string
              description: one of the following time frames - hour/day/week/month/year
              example: day