Skip to content

Commit

Permalink
Update openapi docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mradavi committed Sep 4, 2024
1 parent 968c30b commit d3818c2
Showing 1 changed file with 60 additions and 0 deletions.
60 changes: 60 additions & 0 deletions docs/openapi.yml
Original file line number Diff line number Diff line change
Expand Up @@ -1941,6 +1941,50 @@ paths:
application/json:
schema:
$ref: "#/components/schemas/403Forbidden"
/v1/taxonomy:
get:
tags:
- Taxonomy
summary: Get results of taxonomy search by id or name
parameters:
- name: search
in: query
description: Search query that is a partial or full id, scientific or common name
schema:
type: string
required: true
- name: results
in: query
description: Amount of search results to retrieve (by default 10)
schema:
type: string
responses:
200:
description: OK
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/TaxonomyResult"
400:
description: Bad Request
content:
application/json:
schema:
$ref: "#/components/schemas/400BadRequest"
401:
description: Unauthorized
content:
application/json:
schema:
$ref: "#/components/schemas/401Unauthorized"
403:
description: Forbidden
content:
application/json:
schema:
$ref: "#/components/schemas/403Forbidden"

components:
schemas:
Expand Down Expand Up @@ -3324,3 +3368,19 @@ components:
type: string
title: Error for file if status is failed
description: required only if status is failed
TaxonomyResult:
type: object
description: Taxonomy search result
properties:
tax_id:
type: string
title: Taxonomy id
example: 3320
scientific_name:
type: string
title: Scientific name
example: Abies magnifica
common_name:
type: string
title: Common name or genbank common name (if available)
example: red fir

0 comments on commit d3818c2

Please sign in to comment.