Cenevo Tags API

openapi: 3.0.0
info:
  title: Labguru Antibodies Tags 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: Tags
paths:
  /api/v1/tags:
    post:
      summary: Add tag
      tags:
      - Tags
      parameters: []
      responses:
        '201':
          description: tag created
        '404':
          description: invalid request - Item not found
        '401':
          description: 'Error: Unauthorized'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/createTag'
        required: true
    delete:
      summary: Remove tag labels from an item
      tags:
      - Tags
      description: Removes one or more tag labels from a single item. This does not delete the tag record itself - use DELETE /api/v1/tags/{id} for that. The tag field accepts a comma-separated string to remove multiple labels at once.
      parameters:
      - name: token
        in: query
        required: true
        schema:
          type: string
      responses:
        '201':
          description: success
        '404':
          description: item not found
        '422':
          description: invalid item type
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - item
              properties:
                item:
                  type: object
                  required:
                  - class_name
                  - item_id
                  - tag
                  properties:
                    class_name:
                      type: string
                      description: The class name of the item to remove the tag from (e.g. Projects::Experiment)
                    item_id:
                      type: integer
                      description: The ID of the item to remove the tag from
                    tag:
                      type: string
                      description: Tag label(s) to remove. Comma-separated for multiple labels (e.g. "draft,wip")
        required: true
  /api/v1/tags/{id}:
    delete:
      summary: Delete tag
      tags:
      - Tags
      parameters:
      - name: token
        in: query
        required: true
        schema:
          type: string
      - name: id
        in: path
        required: true
        description: tag id
        schema:
          type: integer
      responses:
        '201':
          description: success
        '404':
          description: not found
components:
  schemas:
    createTag:
      type: object
      required:
      - token
      properties:
        token:
          type: string
          example: YOUR TOKEN IS HERE
        item:
          type: object
          required:
          - tag
          - class_name
          - item_id
          properties:
            tag:
              type: string
              description: 'the tag name '
            class_name:
              type: string
              description: the item type to tag
              example: Biocollections::Antibody
            item_id:
              type: string
              description: The ID of the item to tag