-
Notifications
You must be signed in to change notification settings - Fork 20
/
endpoints.yaml
151 lines (151 loc) · 4.53 KB
/
endpoints.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
openapi: 3.0.2
servers: []
info:
version: 2.0.0
title: GA4GH Beacon API Specification
description: A Beacon is a web service for genetic data sharing that can be queried
for information about variants, individuals, biosamples, and other entities.
contact:
email: beacon@ga4gh.org
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
paths:
/:
parameters:
- $ref: '#/components/parameters/requestedSchema'
get:
description: Get information about the beacon
operationId: getBeaconRoot
tags:
- Informational endpoints
responses:
'200':
$ref: '#/components/responses/infoOKResponse'
default:
description: An unsuccessful operation.
$ref: ./responses/beaconErrorResponse.yaml
/info:
parameters:
- $ref: '#/components/parameters/requestedSchema'
get:
description: Get information about the beacon
operationId: getBeaconInfoRoot
tags:
- Informational endpoints
responses:
'200':
$ref: '#/components/responses/infoOKResponse'
default:
description: An unsuccessful operation.
$ref: ./responses/beaconErrorResponse.yaml
/service-info:
get:
description: Get information about the beacon using GA4GH ServiceInfo format
operationId: getBeaconServiceInfo
tags:
- Informational endpoints
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: ./responses/ga4gh-service-info-1-0-0-schema.yaml
/configuration:
get:
description: TBD
operationId: getBeaconConfiguration
tags:
- Configuration
responses:
'200':
description: Successful operation.
content:
application/json:
schema:
description: Response of a request for information about a Beacon
$ref: ./responses/beaconConfigurationResponse.yaml
default:
description: An unsuccessful operation.
$ref: ./responses/beaconErrorResponse.yaml
/map:
get:
description: TBD
operationId: getBeaconMap
tags:
- Configuration
parameters: []
responses:
'200':
description: Successful operation.
content:
application/json:
schema:
description: Response of a request for information about a Beacon
$ref: ./responses/beaconMapResponse.yaml
default:
description: An unsuccessful operation.
$ref: ./responses/beaconErrorResponse.yaml
/entry_types:
get:
description: TBD
operationId: getEntryTypes
tags:
- Configuration
parameters: []
responses:
'200':
description: Successful operation.
content:
application/json:
schema:
description: Response of a request for information about a Beacon
$ref: ./responses/beaconEntryTypesResponse.yaml
default:
description: An unsuccessful operation.
$ref: ./responses/beaconErrorResponse.yaml
/filtering_terms:
parameters:
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/limit'
get:
description: Get the list of filtering terms handled by this beacon
operationId: getFilteringTerms
tags:
- Informational endpoints
responses:
'200':
$ref: ./responses/beaconFilteringTermsResponse.yaml
default:
description: An unsuccessful operation.
$ref: ./responses/beaconErrorResponse.yaml
components:
responses:
infoOKResponse:
description: Successful operation.
content:
application/json:
schema:
description: Response of a request for information about a Beacon.
$ref: ./responses/beaconInfoResponse.yaml
parameters:
requestedSchema:
name: requestedSchema
description: Schema to be used to format the `result` field in the resposne.
The response will use Beacon format.
in: query
required: false
schema:
type: string
example: ga4gh-service-info-v1.0
skip:
name: skip
in: query
schema:
$ref: ./common/beaconCommonComponents.yaml#/definitions/Skip
limit:
name: limit
in: query
schema:
$ref: ./common/beaconCommonComponents.yaml#/definitions/Limit