-
Notifications
You must be signed in to change notification settings - Fork 0
/
govalert.yaml
176 lines (176 loc) · 4.72 KB
/
govalert.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
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
openapi: 3.0.1
info:
title: Govalert Weather API
description: 'This is the govalert API'
contact:
email: [email protected]
version: 1.0.0
paths:
/warnings:
get:
summary: Get list of states where relevant inclement weather events are occuring currently
responses:
200:
description: successful operation
content:
application/json:
schema:
type: array
items:
type: string
/contracts/state/{state_code}:
get:
summary: Given a state get the contracts impacted by an approaching weather event
parameters:
- name: state_code
in: path
description: Two letter ID of the state
required: true
schema:
type: string
responses:
200:
description: successful operation
content:
application/json:
schema:
type: object
properties:
state:
type: string
weatherEvents:
type: array
items:
$ref: '#/components/schemas/WeatherEvent'
/contracts/agency/{agency_code}:
get:
summary: Given an agency get the contracts impacted by an approaching weather event
parameters:
- name: agency_code
in: path
description: Agency Id
required: true
schema:
type: string
responses:
200:
description: successful operation
content:
application/json:
schema:
type: object
properties:
weatherEvents:
type: array
items:
type: object
properties:
weatherEventId:
type: string
weatherEventUrl:
type: string
contracts:
type: array
items:
$ref: '#/components/schemas/Contract'
/contracts/contractor/{contractor_id}:
get:
summary: Given an agency get the contracts impacted by an approaching weather event
parameters:
- name: contractor_id
in: path
description: Id of the contractor
required: true
schema:
type: string
responses:
200:
description: successful operation
content:
application/json:
schema:
type: object
properties:
weatherEvents:
type: array
items:
type: object
properties:
weatherEventId:
type: string
weatherEventUrl:
type: string
contracts:
type: array
items:
$ref: '#/components/schemas/Contract'
components:
schemas:
WeatherEvent:
type: object
properties:
weatherEventId:
type: string
weatherEventUrl:
type: string
affectedZones:
type: array
items:
type: string
contracts:
type: array
items:
$ref: '#/components/schemas/Contract'
Contract:
type: object
properties:
awardIdPiid:
type: string
parentAwardAgencyName:
type: string
federalActionObligation:
type: number
totalDollarsObligated:
type: number
baseAndExercisedOptionsValue:
type: number
currentTotalValueOfAward:
type: number
actionDate:
type: string
periodOfPerformanceStartDate:
type: string
periodOfPerformanceCurrentEndDate:
type: string
awardingAgencyCode:
type: string
awardingAgencyName:
type: string
awardingOfficeCode:
type: string
awardingOfficeName:
type: string
primaryPlaceOfPerformanceZip:
type: string
awardType:
type: string
lastModifiedDate:
type: string
recipient:
$ref: '#/components/schemas/Contractor'
Contractor:
type: object
properties:
duns:
type: string
name:
type: string
cageCode:
type: string
Agency:
type: object
properties:
agencyCode:
type: string
name:
type: string