-
Notifications
You must be signed in to change notification settings - Fork 16
/
discovery_api_article_swag.json
214 lines (214 loc) · 10.6 KB
/
discovery_api_article_swag.json
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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
{
"notes": "This is a longer string of important things",
"responses": {
"200": {
"description" : "Search was successful",
"schema": {
"properties": {
"pageSize": {
"type": "integer"
},
"query": {
"type": "string"
},
"timestamp": {
"type": "string",
"format": "dateTime"
},
"total": {
"type": "integer"
},
"results": {
"items": {
"type": "object",
"properties": {
"last_updated": {
"type": "string",
"format": "dateTime"
},
"id": {
"type": "string"
},
"bibjson": {
"type": "object",
"properties": {
"start_page": {
"type": "integer"
},
"author": {
"items": {
"type": "object",
"properties": {
"affiliation": {
"type": "string"
},
"email": {
"type": "string"
},
"name": {
"type": "string"
},
"orcid_id": {
"type": "string"
}
},
"title": "author"
},
"type": "array"
},
"journal": {
"type": "object",
"properties": {
"volume": {
"type": "string"
},
"publisher": {
"type": "string"
},
"language": {
"items": {
"type": "string"
},
"type": "array"
},
"title": {
"type": "string"
},
"country": {
"type": "string"
},
"number": {
"type": "string"
}
},
"title": "journal"
},
"title": {
"type": "string"
},
"subject": {
"items": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"term": {
"type": "string"
},
"scheme": {
"type": "string"
}
},
"title": "subject"
},
"type": "array"
},
"month": {
"type": "string"
},
"link": {
"items": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"type": {
"type": "string"
},
"content_type": {
"type": "string"
}
},
"title": "link"
},
"type": "array"
},
"year": {
"type": "string"
},
"keywords": {
"items": {
"type": "string"
},
"type": "array"
},
"identifier": {
"items": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"id": {
"type": "string"
}
},
"title": "identifier"
},
"type": "array"
},
"abstract": {
"type": "string"
},
"end_page": {
"type": "string"
}
},
"title": "bibjson"
},
"created_date": {
"type": "string",
"format": "dateTime"
}
},
"title": "Article"
},
"type": "array"
},
"page": {
"type": "integer"
}
},
"title": "Article search"
}
},
"400": {
"description": "Bad Request"
}
},
"parameters": [
{
"description": "<div class=\"search-query-docs\"> What you are searching for, e.g. computers <br> <br> You can search inside any field you see in the results or the schema. <a href=\"#specific_field_search\">More details</a> <br> For example, to search for all articles with abstracts containing the word \"shadow\" <pre>bibjson.abstract:\"shadow\"</pre> <a href=\"#short_field_names\">Short-hand names are available</a> for some fields <pre>doi:10.3389/fpsyg.2013.00479</pre> <pre>issn:1874-9496</pre> <pre>license:CC-BY</pre> <pre>title:hydrostatic pressure</pre> </div>",
"required": true,
"type": "string",
"name": "search_query",
"in": "path"
},
{
"description": "Which page of the results you wish to see.",
"required": false,
"type": "integer",
"name": "page",
"in": "query"
},
{
"description": "How many results per page you wish to see, the default is 10.",
"required": false,
"type": "integer",
"name": "pageSize",
"in": "query"
},
{
"description": "<div> Substitutions are also available here for convenience <ul> <li>title - order by the normalised, unpunctuated version of the title</li> </ul> For example <pre>title:asc</pre> </div>",
"required": false,
"type": "string",
"name": "sort",
"in": "query"
}
],
"tags": [
"Search"
]
}