-
Notifications
You must be signed in to change notification settings - Fork 0
/
openapi.yaml
199 lines (193 loc) · 5.32 KB
/
openapi.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
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
openapi: "3.0.0"
info:
version: 0.0.3
title: HRXP Archive API
tags:
- name: Channels
paths:
/channels:
get:
tags: [Channels]
summary: Returns a list of all channels
responses:
200:
description: OK; data in response
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/Channel"
/channels/{channelId}/messages:
parameters:
- $ref: "#/components/parameters/channelId"
get:
tags: [Channels]
summary: Return a specific channel's messages
responses:
200:
description: OK; data in response
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/Message"
/auth/access_token:
post:
tags: [Auth]
summary: exchange a Slack OAuth authorization code for a JWT
requestBody:
description: Payload that includes the OAuth Authorization Code from Slack
content:
application/json:
schema:
type: object
properties:
code:
type: string
responses:
200:
description: success! JWT in response
components:
schemas:
Channel:
type: object
properties:
_id:
type: string
example: edveevere2323dc3
slackId:
type: string
example: C035Z8YT7
name:
type: string
example: general
topic:
type: string
example: Mission 1st, People Always.
purpose:
type: string
example: This channel is for alumni of all Hack Reactor campuses.
members:
type: array
items:
$ref: "#/components/schemas/User/properties/_id"
isArchived:
type: boolean
default: false
Message:
type: object
properties:
_id:
type: string
example: a55dd3e2-1b1c-4ee8-a05e-9a35dda5710a
ts:
$ref: "#/components/schemas/__Timestamp"
type:
type: string
example: thread
channelName:
type: string
example: general
channelId:
type: string
example: a55dd3e2-1b1c-4ee8-a05e-9a35dda5710a
text:
type: string
example: Happy Monday, everyone!
files:
type: array
items:
type: object
properties:
_id:
type: string
example: a55dd3e2-1b1c-4ee8-a05e-9a35dda5710a
slackId:
type: string
example: FJ0UW704
displayName:
type: string
example: contractor-description.pdf
fileType:
type: string
example: pdf
downloadUrl:
type: string
format: url
example: "https://hrxp.com/static/files/FJ0UW704E/contractor-description.pdf"
replies:
type: array
items:
properties:
_id:
type: string
example: a55dd3e2-1b1c-4ee8-a05e-9a35dda5710b
createdBy:
$ref: "#/components/schemas/User"
ts:
$ref: "#/components/schemas/__Timestamp"
text:
type: string
type:
type: string
example: reply
channelName:
type: string
example: general
channelId:
type: string
example: a55dd3e2-1b1c-4ee8-a05e-9a35dda5710a
files:
type: array
items:
type: object
properties:
_id:
type: string
example: a55dd3e2-1b1c-4ee8-a05e-9a35dda5710a
slackId:
type: string
example: FJ0UW704
displayName:
type: string
example: contractor-description.pdf
fileType:
type: string
example: pdf
downloadUrl:
type: string
format: url
example: "https://hrxp.com/static/files/FJ0UW704E/contractor-description.pdf"
createdBy:
$ref: "#/components/schemas/User"
User:
type: object
properties:
_id:
type: string
example: a55dd3e2-1b1c-4ee8-a05e-9a35dda5710a
slackId:
type: string
example: U07AT4FB4
profilePhoto:
type: string
example: "https://hrxp.com/static/avatars/U07AT4FB4.png"
displayName:
type: string
example: "Kyle Shockey [HR26]"
realName:
type: string
example: Kyle Shockey
# UTILITY SCHEMAS, which are just broken out for reusability
__Timestamp:
type: string
example: "1501536037.682405"
parameters:
channelId:
name: channelId
in: path
required: true
schema:
$ref: "#/components/schemas/Channel/properties/_id"