openapi: 3.0.0
info:
  title: Labguru Antibodies Primers 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: Primers
paths:
  /api/v1/primers:
    post:
      summary: Creates a primer
      tags:
      - Primers
      description: 'Create a primer.

        '
      parameters: []
      responses:
        '201':
          description: Created
        '422':
          description: invalid request
        '401':
          description: 'Error: Unauthorized'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/createPrimer'
        required: true
    get:
      summary: List all primers in your account
      tags:
      - Primers
      description: 'List all primers.

        '
      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: OK
        '404':
          description: Not found
        '401':
          description: 'Error: Unauthorized'
  /api/v1/primers/{id}:
    put:
      summary: Update primer
      tags:
      - Primers
      description: 'Update a primer.

        '
      parameters:
      - name: id
        in: path
        required: true
        description: The ID of the primer
        schema:
          type: integer
      responses:
        '200':
          description: OK
        '422':
          description: invalid request
        '401':
          description: 'Error: Unauthorized'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/updatePrimer'
        required: true
    get:
      summary: Get primer by ID
      tags:
      - Primers
      description: 'Get primer by ID.

        '
      parameters:
      - name: token
        in: query
        required: true
        schema:
          type: string
      - name: id
        in: path
        required: true
        description: The ID of the primer
        schema:
          type: integer
      responses:
        '200':
          description: OK
        '404':
          description: Not found
        '401':
          description: 'Error: Unauthorized'
    delete:
      summary: Delete primer
      tags:
      - Primers
      parameters:
      - name: token
        in: query
        required: true
        schema:
          type: string
      - name: id
        in: path
        required: true
        description: primer id
        schema:
          type: integer
      responses:
        '204':
          description: no content
        '404':
          description: not found
components:
  schemas:
    createPrimer:
      allOf:
      - $ref: '#/components/schemas/PrimerBaseRequest'
      - type: object
        properties:
          item:
            type: object
            required:
            - title
    PrimerBaseRequest:
      type: object
      required:
      - token
      properties:
        token:
          type: string
          example: YOUR TOKEN IS HERE
        item:
          type: object
          properties:
            title:
              type: string
              description: The name of the primer
            alternative_name:
              type: string
              description: Any alternative name by which the primer may be known
            owner_id:
              type: integer
              description: id of the owner - if omitted, will default to your member id
            sequence:
              type: string
              description: The nucleotide sequence of the primer
            tag:
              type: string
              description: A unique label or tag associated with the primer
            gene_id:
              type: integer
              nullable: true
              description: A reference ID linking the primer to a specific gene in your lab
            tm:
              type: string
              description: The melting temperature (Tm) of the primer
              example: 3
            orientation:
              type: string
              description: Indicates the orientation of the primer. Set "1" for forward and "0" for reverse. This field is optional and can be left null if orientation is not applicable
              nullable: true
              example: '1'
            target_position:
              type: string
              description: The specific binding position of the primer on the target DNA
            fragment_size:
              type: string
              description: The size of the DNA fragment that the primer is designed to amplify
            organism:
              type: string
              description: The specific organism for which the primer is designed, such as "Mouse"
            used_for:
              type: string
              description: The specific applications for which the primer is used (pcr / RT / SDM / etc.)
            restriction_site:
              type: string
              description: Information about any restriction enzyme recognition sites incorporated into the primer design
            source:
              type: string
              description: The origin or source from which the primer was obtained
            description:
              type: string
              description: A detailed description of the primer
    updatePrimer:
      allOf:
      - $ref: '#/components/schemas/PrimerBaseRequest'