|
3 | 3 | title: "SynBioHub Download API" |
4 | 4 | version: "1.0.0" |
5 | 5 | description: "API endpoints for downloading content from SynBioHub in various formats" |
6 | | - |
| 6 | + |
7 | 7 | servers: |
8 | | - - url: 'https://synbiohub.org' |
| 8 | + - url: "https://synbiohub.org" |
9 | 9 | description: Main SynBioHub instance |
10 | | - - url: 'http://localhost:7777' |
| 10 | + - url: "http://localhost:7777" |
11 | 11 | description: Local development instance |
12 | 12 |
|
13 | 13 | components: |
@@ -49,15 +49,20 @@ paths: |
49 | 49 | - userToken: [] |
50 | 50 | - {} |
51 | 51 | responses: |
52 | | - '200': |
| 52 | + "200": |
53 | 53 | description: SBOL document |
54 | 54 | content: |
55 | 55 | application/rdf+xml: |
56 | 56 | schema: |
57 | 57 | type: string |
58 | | - '403': |
| 58 | + example: | |
| 59 | + <?xml version="1.0" encoding="UTF-8"?> |
| 60 | + <rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" xmlns:sbol="http://sbols.org/v2#"> |
| 61 | + <!-- SBOL RDF content --> |
| 62 | + </rdf:RDF> |
| 63 | + "403": |
59 | 64 | description: Not authorized to access this object |
60 | | - '404': |
| 65 | + "404": |
61 | 66 | description: Object not found |
62 | 67 | tags: |
63 | 68 | - Download |
@@ -89,15 +94,20 @@ paths: |
89 | 94 | - userToken: [] |
90 | 95 | - {} |
91 | 96 | responses: |
92 | | - '200': |
| 97 | + "200": |
93 | 98 | description: SBOL document (non-recursive) |
94 | 99 | content: |
95 | 100 | application/rdf+xml: |
96 | 101 | schema: |
97 | 102 | type: string |
98 | | - '403': |
| 103 | + example: | |
| 104 | + <?xml version="1.0" encoding="UTF-8"?> |
| 105 | + <rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" xmlns:sbol="http://sbols.org/v2#"> |
| 106 | + <!-- SBOL RDF content (non-recursive) --> |
| 107 | + </rdf:RDF> |
| 108 | + "403": |
99 | 109 | description: Not authorized to access this object |
100 | | - '404': |
| 110 | + "404": |
101 | 111 | description: Object not found |
102 | 112 | tags: |
103 | 113 | - Download |
@@ -129,15 +139,15 @@ paths: |
129 | 139 | - userToken: [] |
130 | 140 | - {} |
131 | 141 | responses: |
132 | | - '200': |
| 142 | + "200": |
133 | 143 | description: Metadata in JSON format |
134 | 144 | content: |
135 | 145 | application/json: |
136 | 146 | schema: |
137 | 147 | type: object |
138 | | - '403': |
| 148 | + "403": |
139 | 149 | description: Not authorized to access this object |
140 | | - '404': |
| 150 | + "404": |
141 | 151 | description: Object not found |
142 | 152 | tags: |
143 | 153 | - Download |
@@ -169,15 +179,15 @@ paths: |
169 | 179 | - userToken: [] |
170 | 180 | - {} |
171 | 181 | responses: |
172 | | - '200': |
| 182 | + "200": |
173 | 183 | description: GenBank file |
174 | 184 | content: |
175 | 185 | text/plain: |
176 | 186 | schema: |
177 | 187 | type: string |
178 | | - '403': |
| 188 | + "403": |
179 | 189 | description: Not authorized to access this object |
180 | | - '404': |
| 190 | + "404": |
181 | 191 | description: Object not found |
182 | 192 | tags: |
183 | 193 | - Download |
@@ -209,15 +219,15 @@ paths: |
209 | 219 | - userToken: [] |
210 | 220 | - {} |
211 | 221 | responses: |
212 | | - '200': |
| 222 | + "200": |
213 | 223 | description: FASTA file |
214 | 224 | content: |
215 | 225 | text/plain: |
216 | 226 | schema: |
217 | 227 | type: string |
218 | | - '403': |
| 228 | + "403": |
219 | 229 | description: Not authorized to access this object |
220 | | - '404': |
| 230 | + "404": |
221 | 231 | description: Object not found |
222 | 232 | tags: |
223 | 233 | - Download |
@@ -249,15 +259,15 @@ paths: |
249 | 259 | - userToken: [] |
250 | 260 | - {} |
251 | 261 | responses: |
252 | | - '200': |
| 262 | + "200": |
253 | 263 | description: GFF3 file |
254 | 264 | content: |
255 | 265 | text/plain: |
256 | 266 | schema: |
257 | 267 | type: string |
258 | | - '403': |
| 268 | + "403": |
259 | 269 | description: Not authorized to access this object |
260 | | - '404': |
| 270 | + "404": |
261 | 271 | description: Object not found |
262 | 272 | tags: |
263 | 273 | - Download |
0 commit comments