forked from dricazenck/wcc-api
-
Notifications
You must be signed in to change notification settings - Fork 0
/
api_about.yml
193 lines (178 loc) · 5.75 KB
/
api_about.yml
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
openapi: 3.0.0
info:
title: Session "About" APIs
description: API to retrieve information about team members
version: 1.0.0
servers:
- url: http://localhost:8080/api/cms/v1
- url: https://wcc-cms.fly.dev/api/cms/v1
paths:
/team:
get:
summary: Get team members grouped by MemberType
parameters:
- $ref: 'parameters/memberType.yml'
- $ref: 'parameters/page.yml'
- $ref: 'parameters/pageSize.yml'
security:
- apiKey: [ ]
responses:
'200':
description: List the content of Team's Page
content:
application/json:
schema:
$ref: '#/components/schemas/TeamPage'
'401':
$ref: 'schemas/responses.yml#/components/responses/Unauthorized'
'403':
$ref: 'schemas/responses.yml#/components/responses/Forbidden'
'404':
$ref: 'schemas/responses.yml#/components/responses/NotFound'
'406':
$ref: 'schemas/responses.yml#/components/responses/NotAcceptable'
'429':
$ref: 'schemas/responses.yml#/components/responses/TooManyRequests'
'5XX':
$ref: 'schemas/responses.yml#/components/responses/UnexpectedError'
default:
$ref: 'schemas/responses.yml#/components/responses/Forbidden'
/collaborators:
get:
summary: Get all volunteers in the community that are not part of the leadership team
parameters:
- $ref: 'parameters/page.yml'
- $ref: 'parameters/pageSize.yml'
security:
- apiKey: [ ]
responses:
'200':
description: List the content of collaborator.json's page with pagination
content:
application/json:
schema:
$ref: '#/components/schemas/CollaboratorPagePaginated'
'401':
$ref: 'schemas/responses.yml#/components/responses/Unauthorized'
'403':
$ref: 'schemas/responses.yml#/components/responses/Forbidden'
'404':
$ref: 'schemas/responses.yml#/components/responses/NotFound'
'406':
$ref: 'schemas/responses.yml#/components/responses/NotAcceptable'
'429':
$ref: 'schemas/responses.yml#/components/responses/TooManyRequests'
'5XX':
$ref: 'schemas/responses.yml#/components/responses/UnexpectedError'
default:
$ref: 'schemas/responses.yml#/components/responses/Forbidden'
/code-of-conduct:
get:
summary: Get Code of Conduct
security:
- apiKey: [ ]
responses:
'200':
description: List the content of Code of Conduct's Page
content:
application/json:
schema:
$ref: '#/components/schemas/CodeOfConductPage'
'401':
$ref: 'schemas/responses.yml#/components/responses/Unauthorized'
'403':
$ref: 'schemas/responses.yml#/components/responses/Forbidden'
'404':
$ref: 'schemas/responses.yml#/components/responses/NotFound'
'406':
$ref: 'schemas/responses.yml#/components/responses/NotAcceptable'
'429':
$ref: 'schemas/responses.yml#/components/responses/TooManyRequests'
'5XX':
$ref: 'schemas/responses.yml#/components/responses/UnexpectedError'
default:
$ref: 'schemas/responses.yml#/components/responses/Forbidden'
components:
securitySchemes:
apiKey:
type: apiKey
in: header
name: X-API-Key
schemas:
TeamPage:
type: object
required:
- page
- membersByType
additionalProperties: false
properties:
page:
$ref: 'schemas/attributes.yml#/components/schemas/attributes/SimplePage'
contact:
$ref: 'schemas/attributes.yml#/components/schemas/attributes/Contact'
membersByType:
type: object
additionalProperties: false
properties:
directors:
type: array
maxItems: 10
items:
$ref: 'schemas/domain.yml#/components/schemas/Member'
leads:
type: array
maxItems: 30
items:
$ref: 'schemas/domain.yml#/components/schemas/Member'
evangelists:
maxItems: 6
type: array
items:
$ref: 'schemas/domain.yml#/components/schemas/Member'
CollaboratorPage:
type: object
additionalProperties: false
properties:
page:
$ref: 'schemas/attributes.yml#/components/schemas/attributes/SimplePage'
contact:
$ref: 'schemas/attributes.yml#/components/schemas/attributes/Contact'
collaborators:
type: array
maxItems: 30
items:
$ref: '#/components/schemas/Collaborator'
Collaborator:
type: object
required:
- details
- memberType
additionalProperties: false
properties:
details:
$ref: 'schemas/domain.yml#/components/schemas/Member'
memberType:
$ref: 'schemas/enums.yml#/components/schemas/MemberType'
CollaboratorPagePaginated:
type: object
required:
- data
- metadata
additionalProperties: false
properties:
data:
$ref: '#/components/schemas/CollaboratorPage'
metadata:
$ref: 'schemas/responses.yml#/components/schemas/Metadata'
CodeOfConductPage:
type: object
properties:
page:
$ref: 'schemas/attributes.yml#/components/schemas/attributes/SimplePage'
sections:
type: array
maxItems: 10
items:
$ref: 'schemas/attributes.yml#/components/schemas/attributes/SimpleSection'
security:
- apiKey: [ ]