Skip to content

Commit f14bf3b

Browse files
BradHolmesBradHolmes
authored
Merge pull request #486 from ncbi/release/v18.2.0
Release updated docs for v18.2.0
2 parents aa2262f + bf87dac commit f14bf3b

2 files changed

Lines changed: 516 additions & 0 deletions

File tree

‎client/openapi/openapi3_v2.yaml‎

Lines changed: 258 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3605,6 +3605,16 @@ paths:
36053605
- NM_001408458.1
36063606
- NM_001407959.1
36073607
summary: Selected transcripts from BRCA1
3608+
- name: sort.field
3609+
in: query
3610+
required: false
3611+
schema:
3612+
type: string
3613+
- name: sort.direction
3614+
in: query
3615+
required: false
3616+
schema:
3617+
$ref: '#/components/schemas/v2SortDirection'
36083618
/gene/accession/{accessions}:
36093619
get:
36103620
summary: Get gene metadata by RefSeq Accession
@@ -3718,6 +3728,16 @@ paths:
37183728
- NM_001408458.1
37193729
- NM_001407959.1
37203730
summary: Selected transcripts from BRCA1
3731+
- name: sort.field
3732+
in: query
3733+
required: false
3734+
schema:
3735+
type: string
3736+
- name: sort.direction
3737+
in: query
3738+
required: false
3739+
schema:
3740+
$ref: '#/components/schemas/v2SortDirection'
37213741
/gene/symbol/{symbols}/taxon/{taxon}:
37223742
get:
37233743
summary: Get gene metadata by gene symbol
@@ -3842,6 +3862,16 @@ paths:
38423862
- NM_001408458.1
38433863
- NM_001407959.1
38443864
summary: Selected transcripts from BRCA1
3865+
- name: sort.field
3866+
in: query
3867+
required: false
3868+
schema:
3869+
type: string
3870+
- name: sort.direction
3871+
in: query
3872+
required: false
3873+
schema:
3874+
$ref: '#/components/schemas/v2SortDirection'
38453875
/gene/taxon/{taxon}:
38463876
get:
38473877
summary: Get gene reports by taxonomic identifier
@@ -3976,6 +4006,16 @@ paths:
39764006
- NM_001408458.1
39774007
- NM_001407959.1
39784008
summary: Selected transcripts from BRCA1
4009+
- name: sort.field
4010+
in: query
4011+
required: false
4012+
schema:
4013+
type: string
4014+
- name: sort.direction
4015+
in: query
4016+
required: false
4017+
schema:
4018+
$ref: '#/components/schemas/v2SortDirection'
39794019
/gene:
39804020
post:
39814021
summary: Get gene metadata as JSON
@@ -4130,6 +4170,16 @@ paths:
41304170
example-0:
41314171
value: PROTEIN_CODING
41324172
summary: Only protein coding genes
4173+
- name: sort.field
4174+
in: query
4175+
required: false
4176+
schema:
4177+
type: string
4178+
- name: sort.direction
4179+
in: query
4180+
required: false
4181+
schema:
4182+
$ref: '#/components/schemas/v2SortDirection'
41334183
/gene/accession/{accessions}/dataset_report:
41344184
get:
41354185
summary: Get dataset reports by accession IDs
@@ -4245,6 +4295,16 @@ paths:
42454295
example-0:
42464296
value: PROTEIN_CODING
42474297
summary: Only protein coding genes
4298+
- name: sort.field
4299+
in: query
4300+
required: false
4301+
schema:
4302+
type: string
4303+
- name: sort.direction
4304+
in: query
4305+
required: false
4306+
schema:
4307+
$ref: '#/components/schemas/v2SortDirection'
42484308
/gene/symbol/{symbols}/taxon/{taxon}/dataset_report:
42494309
get:
42504310
summary: Get dataset reports by taxons.
@@ -4371,6 +4431,16 @@ paths:
43714431
example-0:
43724432
value: PROTEIN_CODING
43734433
summary: Only protein coding genes
4434+
- name: sort.field
4435+
in: query
4436+
required: false
4437+
schema:
4438+
type: string
4439+
- name: sort.direction
4440+
in: query
4441+
required: false
4442+
schema:
4443+
$ref: '#/components/schemas/v2SortDirection'
43744444
/gene/taxon/{taxon}/dataset_report:
43754445
get:
43764446
summary: Get gene dataset reports by taxonomic identifier
@@ -4485,6 +4555,16 @@ paths:
44854555
example-0:
44864556
value: PROTEIN_CODING
44874557
summary: Only protein coding genes
4558+
- name: sort.field
4559+
in: query
4560+
required: false
4561+
schema:
4562+
type: string
4563+
- name: sort.direction
4564+
in: query
4565+
required: false
4566+
schema:
4567+
$ref: '#/components/schemas/v2SortDirection'
44884568
/gene/locus_tag/{locus_tags}/dataset_report:
44894569
get:
44904570
summary: Get gene dataset reports by locus tag
@@ -4595,6 +4675,16 @@ paths:
45954675
example-0:
45964676
value: PROTEIN_CODING
45974677
summary: Only protein coding genes
4678+
- name: sort.field
4679+
in: query
4680+
required: false
4681+
schema:
4682+
type: string
4683+
- name: sort.direction
4684+
in: query
4685+
required: false
4686+
schema:
4687+
$ref: '#/components/schemas/v2SortDirection'
45984688
/gene/dataset_report:
45994689
post:
46004690
summary: Get gene dataset report as JSON
@@ -4757,6 +4847,23 @@ paths:
47574847
- NM_001408458.1
47584848
- NM_001407959.1
47594849
summary: Selected transcripts from BRCA1
4850+
- name: tax_search_subtree
4851+
description: 'For queries including a tax-id, include any matching genes annotated on taxa below the selected taxon. By default this is false, and only genes for the selected taxon are returned.'
4852+
in: query
4853+
required: false
4854+
schema:
4855+
type: boolean
4856+
default: false
4857+
- name: sort.field
4858+
in: query
4859+
required: false
4860+
schema:
4861+
type: string
4862+
- name: sort.direction
4863+
in: query
4864+
required: false
4865+
schema:
4866+
$ref: '#/components/schemas/v2SortDirection'
47604867
/gene/accession/{accessions}/product_report:
47614868
get:
47624869
summary: Get gene product reports by accession IDs
@@ -4880,6 +4987,23 @@ paths:
48804987
- NM_001408458.1
48814988
- NM_001407959.1
48824989
summary: Selected transcripts from BRCA1
4990+
- name: tax_search_subtree
4991+
description: 'For queries including a tax-id, include any matching genes annotated on taxa below the selected taxon. By default this is false, and only genes for the selected taxon are returned.'
4992+
in: query
4993+
required: false
4994+
schema:
4995+
type: boolean
4996+
default: false
4997+
- name: sort.field
4998+
in: query
4999+
required: false
5000+
schema:
5001+
type: string
5002+
- name: sort.direction
5003+
in: query
5004+
required: false
5005+
schema:
5006+
$ref: '#/components/schemas/v2SortDirection'
48835007
/gene/symbol/{symbols}/taxon/{taxon}/product_report:
48845008
get:
48855009
summary: Get product reports by taxon.
@@ -5014,6 +5138,23 @@ paths:
50145138
- NM_001408458.1
50155139
- NM_001407959.1
50165140
summary: Selected transcripts from BRCA1
5141+
- name: tax_search_subtree
5142+
description: 'For queries including a tax-id, include any matching genes annotated on taxa below the selected taxon. By default this is false, and only genes for the selected taxon are returned.'
5143+
in: query
5144+
required: false
5145+
schema:
5146+
type: boolean
5147+
default: false
5148+
- name: sort.field
5149+
in: query
5150+
required: false
5151+
schema:
5152+
type: string
5153+
- name: sort.direction
5154+
in: query
5155+
required: false
5156+
schema:
5157+
$ref: '#/components/schemas/v2SortDirection'
50175158
/gene/taxon/{taxon}/product_report:
50185159
get:
50195160
summary: Get gene product reports by taxonomic identifier
@@ -5136,6 +5277,23 @@ paths:
51365277
- NM_001408458.1
51375278
- NM_001407959.1
51385279
summary: Selected transcripts from BRCA1
5280+
- name: tax_search_subtree
5281+
description: 'For queries including a tax-id, include any matching genes annotated on taxa below the selected taxon. By default this is false, and only genes for the selected taxon are returned.'
5282+
in: query
5283+
required: false
5284+
schema:
5285+
type: boolean
5286+
default: false
5287+
- name: sort.field
5288+
in: query
5289+
required: false
5290+
schema:
5291+
type: string
5292+
- name: sort.direction
5293+
in: query
5294+
required: false
5295+
schema:
5296+
$ref: '#/components/schemas/v2SortDirection'
51395297
/gene/locus_tag/{locus_tags}/product_report:
51405298
get:
51415299
summary: Get gene product reports by locus tags
@@ -5254,6 +5412,23 @@ paths:
52545412
- NM_001408458.1
52555413
- NM_001407959.1
52565414
summary: Selected transcripts from BRCA1
5415+
- name: tax_search_subtree
5416+
description: 'For queries including a tax-id, include any matching genes annotated on taxa below the selected taxon. By default this is false, and only genes for the selected taxon are returned.'
5417+
in: query
5418+
required: false
5419+
schema:
5420+
type: boolean
5421+
default: false
5422+
- name: sort.field
5423+
in: query
5424+
required: false
5425+
schema:
5426+
type: string
5427+
- name: sort.direction
5428+
in: query
5429+
required: false
5430+
schema:
5431+
$ref: '#/components/schemas/v2SortDirection'
52575432
/gene/product_report:
52585433
post:
52595434
summary: Get gene product reports as JSON
@@ -10021,6 +10196,13 @@ components:
1002110196
type: array
1002210197
items:
1002310198
type: string
10199+
tax_search_subtree:
10200+
type: boolean
10201+
title: 'For queries including a tax-id, include any matching genes annotated on taxa below the selected taxon. By default this is false, and only genes for the selected taxon are returned.'
10202+
sort:
10203+
type: array
10204+
items:
10205+
$ref: '#/components/schemas/v2SortField'
1002410206
v2GeneDatasetReportsRequestSymbolsForTaxon:
1002510207
type: object
1002610208
properties:
@@ -10939,6 +11121,59 @@ components:
1093911121
use_psg:
1094011122
type: boolean
1094111123
title: 'Experimental approach to retrieving sequence data.'
11124+
v2archiveCatalog:
11125+
type: object
11126+
properties:
11127+
accession:
11128+
type: string
11129+
molecule_type:
11130+
$ref: '#/components/schemas/v2archiveMoleculeType'
11131+
definition:
11132+
type: string
11133+
organism:
11134+
$ref: '#/components/schemas/v2archiveOrganism'
11135+
sequence:
11136+
$ref: '#/components/schemas/v2archiveSequence'
11137+
modification_date:
11138+
type: string
11139+
publication_date:
11140+
type: string
11141+
submitters:
11142+
type: array
11143+
items:
11144+
$ref: '#/components/schemas/v2archiveSubmitter'
11145+
v2archiveNuccoreRequest:
11146+
type: object
11147+
properties:
11148+
accession:
11149+
type: string
11150+
v2archiveOrganism:
11151+
type: object
11152+
properties:
11153+
tax_id:
11154+
type: integer
11155+
common_name:
11156+
type: string
11157+
scientific_name:
11158+
type: string
11159+
v2archiveSequence:
11160+
type: object
11161+
properties:
11162+
length:
11163+
type: string
11164+
units:
11165+
$ref: '#/components/schemas/v2archiveSequenceLengthUnits'
11166+
v2archiveSubmitter:
11167+
type: object
11168+
properties:
11169+
name:
11170+
type: string
11171+
role:
11172+
type: string
11173+
affiliation:
11174+
type: string
11175+
email:
11176+
type: string
1094211177
v2reportsANIMatch:
1094311178
type: object
1094411179
properties:
@@ -13103,6 +13338,7 @@ components:
1310313338
- BLAST_LINK
1310413339
- ASSEMBLY_NUCCORE_REFSEQ
1310513340
- ASSEMBLY_NUCCORE_GENBANK
13341+
- CGV_LINK
1310613342
default: DEFAULT
1310713343
title: 'Types of assembly links that may be returned'
1310813344

@@ -13392,6 +13628,28 @@ components:
1339213628
- cds_span
1339313629
default: unspecified
1339413630

13631+
v2archiveMoleculeType:
13632+
type: string
13633+
enum:
13634+
- MOLECULE_TYPE_UNSPECIFIED
13635+
- GENOMIC_DNA
13636+
- GENOMIC_RNA
13637+
- PRECURSOR_RNA
13638+
- MESSENGER_RNA
13639+
- TRANSFER_RNA
13640+
- RIBOSOMAL_RNA
13641+
- AMINO_ACID
13642+
default: MOLECULE_TYPE_UNSPECIFIED
13643+
13644+
v2archiveSequenceLengthUnits:
13645+
type: string
13646+
enum:
13647+
- SEQUENCE_LENGTH_UNITS_UNSPECIFIED
13648+
- BASE_PAIRS
13649+
- AMINO_ACIDS
13650+
- NUCLEOTIDES
13651+
default: SEQUENCE_LENGTH_UNITS_UNSPECIFIED
13652+
1339513653
v2reportsANITypeCategory:
1339613654
type: string
1339713655
enum:

0 commit comments

Comments
 (0)