Labguru Fungi API

The Fungi API from Labguru — 2 operation(s) for fungi.

OpenAPI Specification

labguru-fungi-api-openapi.yml Raw ↑
openapi: 3.0.0
info:
  title: Labguru Antibodies Fungi 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: Fungi
paths:
  /api/v1/fungi:
    post:
      summary: Create a fungus
      tags:
      - Fungi
      description: 'Creates a fungus.

        '
      parameters: []
      responses:
        '201':
          description: OK
        '422':
          description: Invalid request
        '401':
          description: 'Error: Unauthorized'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/createFungus'
        required: true
    get:
      summary: List all fungi in your account
      tags:
      - Fungi
      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
      description: 'List all fungi.

        '
      responses:
        '200':
          description: OK
        '404':
          description: Not Found
  /api/v1/fungi/{id}:
    put:
      summary: Update fungus
      tags:
      - Fungi
      description: 'Update a fungus.

        '
      parameters:
      - name: id
        in: path
        required: true
        description: The ID of the fungus
        schema:
          type: integer
      responses:
        '200':
          description: OK
        '422':
          description: Invalid request
        '401':
          description: 'Error: Unauthorized'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/updateFungus'
        required: true
    get:
      summary: Get fungus by id
      tags:
      - Fungi
      parameters:
      - name: token
        in: query
        required: true
        schema:
          type: string
      - name: id
        in: path
        required: true
        description: The ID of the fungus
        schema:
          type: integer
      description: 'Get fungus by id.

        '
      responses:
        '200':
          description: OK
        '404':
          description: Not Found
components:
  schemas:
    createFungus:
      allOf:
      - $ref: '#/components/schemas/FungusBaseRequest'
      - type: object
        properties:
          item:
            type: object
            required:
            - name
    FungusBaseRequest:
      type: object
      required:
      - token
      properties:
        token:
          type: string
          example: YOUR TOKEN IS HERE
        item:
          type: object
          properties:
            name:
              type: string
              description: The name of the fungus
            species:
              type: string
              description: Biological species.
            phenotype:
              type: string
              description: Observable traits.
            genotype:
              type: string
              description: Genetic composition.
            host:
              type: string
              description: Associated host organism.
            virulent:
              type: string
              description: Virulence factor.
            sporulate:
              type: string
              description: Ability to form spores.
            mycelia:
              type: string
              description: Mycelial growth.
            fruiting_bodies:
              type: string
              description: Presence of sporocarps.
            owner_id:
              type: integer
              description: id of the owner - by default it's your member id
            source:
              type: string
              description: The origin or source from which the fungus was obtained.
            description:
              type: string
              description: Description of the fungus
    updateFungus:
      allOf:
      - $ref: '#/components/schemas/FungusBaseRequest'