Skip to content

Commit 968bccb

Browse files
IvanGoncharovIvanGoncharov
committed
Add new API specs
1 parent e065093 commit 968bccb

File tree

10 files changed

+32761
-0
lines changed

10 files changed

+32761
-0
lines changed

‎18f.us/0.1/swagger.json

+200
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,200 @@
1+
{
2+
"basePath": "/",
3+
"host": "discovery.18f.us",
4+
"info": {
5+
"contact": {
6+
"email": "[email protected]"
7+
},
8+
"description": "<p>This API drives the <a href=\"https://discovery.gsa.gov\">Discovery Market Research Tool</a>.\nIt contains information on the vendors that are part of the OASIS and OASIS Small Business contracting vehicles, such as their contracting history, their elligibility for contract awards, and their small business designations.\nTo learn more about the tool, please visit <a href=\"https://discovery.gsa.gov\">Discovery</a> or see the README on our <a href=\"https://github.com/18F/mirage\">GitHub repository</a>.</p>\n<p><strong>Please note that the base path for this API is <code>https://api.data.gov/gsa/discovery/</code></strong></p>\n<p>It requires an API key, obtainable at <a href=\"http://api.data.gov/\">api.data.gov</a>.\nIt must be passed in the <code>api_key</code> parameter with each request.</p>",
9+
"title": "Discovery Market Research API",
10+
"version": "0.1",
11+
"x-logo": {
12+
"url": "https://mirage-gsa-gov.s3.amazonaws.com/mirage_site/images/discovery.png"
13+
},
14+
"x-origin": {
15+
"format": "swagger",
16+
"url": "https://discovery.18f.us/docs/api-docs/",
17+
"version": "1.2"
18+
},
19+
"x-providerName": "18f.us"
20+
},
21+
"paths": {
22+
"/api/contracts/": {
23+
"get": {
24+
"description": "<p>This endpoint returns contract history from FPDS for a specific vendor. The vendor's DUNS number is a required parameter. You can also filter contracts by their NAICS code to find contracts relevant to a particular category. </p>",
25+
"operationId": "List_Contracts",
26+
"parameters": [
27+
{
28+
"description": "A 9-digit DUNS number that uniquely identifies a vendor (required).",
29+
"format": "string",
30+
"in": "query",
31+
"name": "duns",
32+
"required": true,
33+
"type": "string"
34+
},
35+
{
36+
"description": "a six digit NAICS code used to filter by contracts with a certain NAICS",
37+
"format": "string",
38+
"in": "query",
39+
"name": "naics",
40+
"required": false,
41+
"type": "string"
42+
},
43+
{
44+
"description": "a field to sort on. Choices are date, status, agency, and amount",
45+
"format": "string",
46+
"in": "query",
47+
"name": "sort",
48+
"required": false,
49+
"type": "string"
50+
},
51+
{
52+
"description": "The sort direction of the results. Choices are asc or desc.",
53+
"format": "string",
54+
"in": "query",
55+
"name": "direction",
56+
"required": false,
57+
"type": "string"
58+
},
59+
{
60+
"description": "the page to start on. Results are paginated in increments of 100. Begins at page=1.",
61+
"format": "string",
62+
"in": "query",
63+
"name": "page",
64+
"required": false,
65+
"type": "string"
66+
}
67+
],
68+
"responses": {
69+
"200": {
70+
"description": "No response was specified"
71+
}
72+
},
73+
"summary": "This endpoint returns contract history from FPDS for a specific vendor",
74+
"tags": [
75+
"contracts"
76+
]
77+
}
78+
},
79+
"/api/metadata/": {
80+
"get": {
81+
"description": "<p>This endpoint returns metadata for the most recent data loads of SAM and FPDS data. It takes no parameters. </p>",
82+
"operationId": "Metadata",
83+
"responses": {
84+
"200": {
85+
"description": "No response was specified"
86+
}
87+
},
88+
"summary": "This endpoint returns metadata for the most recent data loads of SAM and FPDS data",
89+
"tags": [
90+
"metadata"
91+
]
92+
}
93+
},
94+
"/api/naics/": {
95+
"get": {
96+
"description": "<p>This endpoint lists all of the NAICS codes that are relevant to the OASIS family of vehicles. It takes no parameters. </p>",
97+
"operationId": "List_Naics",
98+
"responses": {
99+
"200": {
100+
"description": "No response was specified"
101+
}
102+
},
103+
"summary": "This endpoint lists all of the NAICS codes that are relevant to the OASIS family of vehicles",
104+
"tags": [
105+
"naics"
106+
]
107+
}
108+
},
109+
"/api/vendor/{duns}": {
110+
"get": {
111+
"description": "<p>This endpoint returns a single vendor by their 9 digit DUNS number. DUNS numbers can be looked up in the <a href=\"https://www.sam.gov\">System for Award Management</a> by vendor name. </p>",
112+
"operationId": "Get_Vendor",
113+
"parameters": [
114+
{
115+
"description": "a nine digit DUNS number that uniquely identifies the vendor (required)",
116+
"format": "string",
117+
"in": "path",
118+
"name": "duns",
119+
"required": true,
120+
"type": "string"
121+
}
122+
],
123+
"responses": {
124+
"200": {
125+
"description": "No response was specified"
126+
}
127+
},
128+
"summary": "This endpoint returns a single vendor by their 9 digit DUNS number",
129+
"tags": [
130+
"vendor"
131+
]
132+
}
133+
},
134+
"/api/vendors/": {
135+
"get": {
136+
"description": "<p>This endpoint returns a list of vendors filtered by a NAICS code. The NAICS code maps to an OASIS pool and is used to retrieve vendors in that pool only.</p>\n<p>OASIS pools are groupings of NAICS codes that have the same small business size standard. Because contracts solicited to OASIS vendors can only be issued to one pool, much of the data is presented as part of a pool grouping. Using the NAICS code is a shortcut, so that you don't have to explicitly map the NAICS code to a pool in OASIS yourself.</p>\n<p>Vendors can also be filtered by a particular setaside. Valid values for the setasides are two-character codes which include:</p>\n<ul>\n<li>A6 (8(a))</li>\n<li>XX (Hubzone)</li>\n<li>QF (service disabled veteran owned)</li>\n<li>A2 (women owned)</li>\n<li>A5 (veteran owned)</li>\n<li>27 (small disadvantaged business). </li>\n</ul>",
137+
"operationId": "List_Vendors",
138+
"parameters": [
139+
{
140+
"description": "a six digit NAICS code (required)",
141+
"format": "string",
142+
"in": "query",
143+
"name": "naics",
144+
"required": true,
145+
"type": "string"
146+
},
147+
{
148+
"description": "a comma delimited list of two character setaside codes to filter by. Ex. setasides=A6,A5 will filter by 8a and veteran owned business.",
149+
"in": "query",
150+
"items": {
151+
"format": "string",
152+
"type": "string"
153+
},
154+
"name": "setasides",
155+
"required": false,
156+
"type": "array"
157+
},
158+
{
159+
"description": "Choices are either oasis or oasissb. Will filter vendors by their presence in either the OASIS unrestricted vehicle or the OASIS Small Business vehicle.",
160+
"format": "string",
161+
"in": "query",
162+
"name": "vehicle",
163+
"required": false,
164+
"type": "string"
165+
}
166+
],
167+
"responses": {
168+
"200": {
169+
"description": "No response was specified"
170+
}
171+
},
172+
"summary": "This endpoint returns a list of vendors filtered by a NAICS code",
173+
"tags": [
174+
"vendors"
175+
]
176+
}
177+
}
178+
},
179+
"schemes": [
180+
"https"
181+
],
182+
"swagger": "2.0",
183+
"tags": [
184+
{
185+
"name": "contracts"
186+
},
187+
{
188+
"name": "metadata"
189+
},
190+
{
191+
"name": "naics"
192+
},
193+
{
194+
"name": "vendor"
195+
},
196+
{
197+
"name": "vendors"
198+
}
199+
]
200+
}

‎18f.us/patch.json

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"info": {
3+
"x-logo": {
4+
"url": "https://mirage-gsa-gov.s3.amazonaws.com/mirage_site/images/discovery.png"
5+
}
6+
}
7+
}

0 commit comments

Comments
 (0)