-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathswagger_oa_fixed.yaml
More file actions
290 lines (290 loc) · 17 KB
/
swagger_oa_fixed.yaml
File metadata and controls
290 lines (290 loc) · 17 KB
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
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
openapi: 3.0.1
info:
title: USPTO Office Action APIs (DSAPI)
description: "Combined Office Action APIs: Text Retrieval, Citations, Rejections, and Enriched Citations. These use the DSAPI pattern (form-encoded POST with Lucene/Solr queries)."
contact:
name: Open Data Portal
email: data@uspto.gov
url: https://data.uspto.gov/apis/getting-started
version: 1.0.0
servers:
- url: https://api.uspto.gov
security:
- ApiKeyAuth: []
tags: []
paths:
/api/v1/patent/oa/oa_actions/v1/fields:
get:
tags:
- oa_actions
summary: Provides the general information about the API and the list of fields that can be used to query the dataset.
description: This GET API returns the list of all the searchable field names that are in the oa_actions. Please see the 'fields' attribute which returns an array of field names. Each field or a combination of fields can be searched using the syntax options shown below.
operationId: oa-actions-list-fields
parameters: []
responses:
"200":
description: The dataset api for the given version is found and it is accessible to consume.
content:
application/json:
schema:
type: string
"404":
description: The combination of dataset name and version is not found in the system or it is not published yet to be consumed by public.
content:
application/json:
schema:
type: string
/api/v1/patent/oa/oa_actions/v1/records:
post:
tags:
- oa_actions
summary: Provides search capability for the data set with the given search criteria.
description: This API is based on Solr/Lucense Search. The data is indexed using SOLR. This GET API returns the list of all the searchable field names that are in the Solr Index. Please see the 'fields' attribute which returns an array of field names. Each field or a combination of fields can be searched using the Solr/Lucene Syntax. Please refer https://lucene.apache.org/core/3_6_2/queryparsersyntax.html#Overview for the query syntax. List of field names that are searchable can be determined using above GET api.
operationId: oa-actions-search
parameters: []
requestBody:
content:
application/x-www-form-urlencoded:
schema:
required:
- criteria
type: object
properties:
criteria:
type: string
description: "Uses Lucene Query Syntax in the format of propertyName:value or propertyName:[num1 TO num2]. Please refer 'docs' element in the API response for the property names and use a query syntax based on appropriate data type of the property."
default: '*:*'
start:
type: integer
description: Starting record number. Default value is 0.
format: int32
default: 0
rows:
type: integer
description: "Specify number of rows to be returned. If you run the search with default values, in the response you will see 'numFound' attribute which will tell the number of records available in the dataset."
format: int32
default: 100
required: true
responses:
"200":
description: successful operation
content:
application/json:
schema:
type: array
items:
type: object
additionalProperties:
type: object
properties: {}
"404":
description: No matching record found for the given criteria.
content: {}
/api/v1/patent/oa/oa_citations/v2/fields:
get:
tags:
- oa_citations
summary: Provides the general information about the API and the list of fields that can be used to query the dataset.
description: This GET API returns the list of all the searchable field names that are in the oa_citations. Please see the 'fields' attribute which returns an array of field names. Each field or a combination of fields can be searched using the syntax options shown below.
operationId: oa-citations-list-fields
parameters: []
responses:
"200":
description: The dataset api for the given version is found and it is accessible to consume.
content:
application/json:
schema:
type: string
"404":
description: The combination of dataset name and version is not found in the system or it is not published yet to be consumed by public.
content:
application/json:
schema:
type: string
/api/v1/patent/oa/oa_citations/v2/records:
post:
tags:
- oa_citations
summary: Provides search capability for the data set with the given search criteria.
description: This API is based on Solr/Lucense Search. The data is indexed using SOLR. This GET API returns the list of all the searchable field names that are in the Solr Index. Please see the 'fields' attribute which returns an array of field names. Each field or a combination of fields can be searched using the Solr/Lucene Syntax. Please refer https://lucene.apache.org/core/3_6_2/queryparsersyntax.html#Overview for the query syntax. List of field names that are searchable can be determined using above GET api.
operationId: oa-citations-search
parameters: []
requestBody:
content:
application/x-www-form-urlencoded:
schema:
required:
- criteria
type: object
properties:
criteria:
type: string
description: "Uses Lucene Query Syntax in the format of propertyName:value or propertyName:[num1 TO num2]. Please refer 'docs' element in the API response for the property names and use a query syntax based on appropriate data type of the property."
default: '*:*'
start:
type: integer
description: Starting record number. Default value is 0.
format: int32
default: 0
rows:
type: integer
description: "Specify number of rows to be returned. If you run the search with default values, in the response you will see 'numFound' attribute which will tell the number of records available in the dataset."
format: int32
default: 100
required: true
responses:
"200":
description: successful operation
content:
application/json:
schema:
type: array
items:
type: object
additionalProperties:
type: object
properties: {}
"404":
description: No matching record found for the given criteria.
content: {}
"/api/v1/patent/oa/oa_rejections/v2/fields":
get:
tags:
- oa_rejections
summary: Provides the general information about the API and the list of fields that can be used to query the dataset.
description: This GET API returns the list of all the searchable field names that are in the oa_rejections. Please see the 'fields' attribute which returns an array of field names. Each field or a combination of fields can be searched using the syntax options shown below.
operationId: oa-rejections-list-fields
parameters: []
responses:
'200':
description: The dataset api for the given version is found and it is accessible to consume.
content:
application/json:
schema:
type: string
'404':
description: The combination of dataset name and version is not found in the system or it is not published yet to be consumed by public.
content:
application/json:
schema:
type: string
/api/v1/patent/oa/oa_rejections/v2/records:
post:
tags:
- oa_rejections
summary: Provides search capability for the data set with the given search criteria.
description: This API is based on Solr/Lucense Search. The data is indexed using SOLR. This GET API returns the list of all the searchable field names that are in the Solr Index. Please see the 'fields' attribute which returns an array of field names. Each field or a combination of fields can be searched using the Solr/Lucene Syntax. Please refer https://lucene.apache.org/core/3_6_2/queryparsersyntax.html#Overview for the query syntax. List of field names that are searchable can be determined using above GET api.
operationId: oa-rejections-search
parameters: []
requestBody:
content:
application/x-www-form-urlencoded:
schema:
required:
- criteria
type: object
properties:
criteria:
type: string
description: Uses Lucene Query Syntax in the format of propertyName:value or propertyName:[num1 TO num2]. Please refer 'docs' element in the API response for the property names and use a query syntax based on appropriate data type of the property.
default: "*:*"
start:
type: integer
description: Starting record number. Default value is 0.
format: int32
default: 0
rows:
type: integer
description: Specify number of rows to be returned. If you run the search with default values, in the response you will see 'numFound' attribute which will tell the number of records available in the dataset.
format: int32
default: 100
required: true
responses:
'200':
description: successful operation
content:
application/json:
schema:
type: array
items:
type: object
additionalProperties:
type: object
properties: {}
'404':
description: No matching record found for the given criteria.
content: {}
/api/v1/patent/oa/enriched_cited_reference_metadata/v3/fields:
get:
tags:
- enriched_cited_reference_metadata
summary: Provides the general information about the API and the list of fields that can be used to query the dataset.
description: This GET API returns the list of all the searchable field names that are in the enriched_cited_reference_metadata. Please see the 'fields' attribute which returns an array of field names. Each field or a combination of fields can be searched using the syntax options shown below.
operationId: enriched-citations-list-fields
parameters: []
responses:
"200":
description: The dataset api for the given version is found and it is accessible to consume.
content:
application/json:
schema:
type: string
"404":
description: The combination of dataset name and version is not found in the system or it is not published yet to be consumed by public.
content:
application/json:
schema:
type: string
/api/v1/patent/oa/enriched_cited_reference_metadata/v3/records:
post:
tags:
- enriched_cited_reference_metadata
summary: Provides search capability for the data set with the given search criteria.
description: This API is based on Solr/Lucense Search. The data is indexed using SOLR. This GET API returns the list of all the searchable field names that are in the Solr Index. Please see the 'fields' attribute which returns an array of field names. Each field or a combination of fields can be searched using the Solr/Lucene Syntax. Please refer https://lucene.apache.org/core/3_6_2/queryparsersyntax.html#Overview for the query syntax. List of field names that are searchable can be determined using above GET api.
operationId: enriched-citations-search
parameters: []
requestBody:
content:
application/x-www-form-urlencoded:
schema:
required:
- criteria
type: object
properties:
criteria:
type: string
description: "Uses Lucene Query Syntax in the format of propertyName:value or propertyName:[num1 TO num2]. Please refer 'docs' element in the API response for the property names and use a query syntax based on appropriate data type of the property."
default: '*:*'
start:
type: integer
description: Starting record number. Default value is 0.
format: int32
default: 0
rows:
type: integer
description: "Specify number of rows to be returned. If you run the search with default values, in the response you will see 'numFound' attribute which will tell the number of records available in the dataset."
format: int32
default: 100
required: true
responses:
"200":
description: successful operation
content:
application/json:
schema:
type: array
items:
type: object
additionalProperties:
type: object
properties: {}
"404":
description: No matching record found for the given criteria.
content: {}
components:
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: X-API-KEY
x-original-swagger-version: "2.0"