Skip to content

Commit 88b1481

Browse files
committed
feat: Add swagger endpoints for Netlify Identity
1 parent 9ff3baa commit 88b1481

File tree

1 file changed

+217
-0
lines changed

1 file changed

+217
-0
lines changed

swagger.yml

Lines changed: 217 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -213,6 +213,149 @@ paths:
213213
description: Deleted
214214
default:
215215
$ref: '#/responses/error'
216+
/sites/{site_id}/identity/{identity_instance_id}:
217+
get:
218+
operationId: identityServiceInstance
219+
tags: [identity]
220+
parameters:
221+
- name: site_id
222+
type: string
223+
in: path
224+
required: true
225+
- name: identity_instance_id
226+
type: string
227+
in: path
228+
required: true
229+
responses:
230+
'200':
231+
description: OK
232+
schema:
233+
type: array
234+
items:
235+
$ref: '#/definitions/serviceInstance'
236+
default:
237+
$ref: '#/responses/error'
238+
/sites/{site_id}/identity/{identity_instance_id}/users:
239+
get:
240+
operationId: listSiteUsers
241+
tags: [identity]
242+
parameters:
243+
- name: site_id
244+
type: string
245+
in: path
246+
required: true
247+
- name: identity_instance_id
248+
type: string
249+
in: path
250+
required: true
251+
- $ref: '#/parameters/page'
252+
- $ref: '#/parameters/perPage'
253+
- name: sort
254+
type: string
255+
in: query
256+
- name: filter
257+
type: string
258+
in: query
259+
responses:
260+
'200':
261+
description: OK
262+
schema:
263+
type: array
264+
items:
265+
$ref: '#/definitions/identityUser'
266+
default:
267+
$ref: '#/responses/error'
268+
/sites/{site_id}/identity/{identity_instance_id}/users/{user_id}:
269+
get:
270+
operationId: getSiteUser
271+
tags: [identity]
272+
parameters:
273+
- name: site_id
274+
type: string
275+
in: path
276+
required: true
277+
- name: identity_instance_id
278+
type: string
279+
in: path
280+
required: true
281+
- name: user_id
282+
type: string
283+
in: path
284+
required: true
285+
responses:
286+
'200':
287+
description: OK
288+
schema:
289+
$ref: '#/definitions/identityUser'
290+
default:
291+
$ref: '#/responses/error'
292+
put:
293+
operationId: updateSiteUser
294+
tags: [identity]
295+
consumes:
296+
- application/json
297+
parameters:
298+
- name: site_id
299+
type: string
300+
in: path
301+
required: true
302+
- name: identity_instance_id
303+
type: string
304+
in: path
305+
required: true
306+
- name: user_id
307+
type: string
308+
in: path
309+
required: true
310+
- name: identity
311+
in: body
312+
schema:
313+
type: object
314+
properties:
315+
aud:
316+
type: string
317+
role:
318+
type: string
319+
email:
320+
type: string
321+
format: email
322+
password:
323+
type: string
324+
format: password
325+
confirm:
326+
type: boolean
327+
user_metadata:
328+
$ref: '#/definitions/identityAppMetadata'
329+
app_metadata:
330+
$ref: '#/definitions/identityUserMetadata'
331+
responses:
332+
'200':
333+
description: OK
334+
schema:
335+
$ref: '#/definitions/identityUser'
336+
default:
337+
$ref: '#/responses/error'
338+
delete:
339+
operationId: deleteSiteUser
340+
tags: [identity]
341+
parameters:
342+
- name: site_id
343+
type: string
344+
in: path
345+
required: true
346+
- name: identity_instance_id
347+
type: string
348+
in: path
349+
required: true
350+
- name: user_id
351+
type: string
352+
in: path
353+
required: true
354+
responses:
355+
'200':
356+
description: OK
357+
default:
358+
$ref: '#/responses/error'
216359
/sites/{site_id}/submissions:
217360
get:
218361
operationId: listSiteSubmissions
@@ -2178,6 +2321,9 @@ definitions:
21782321
type: string
21792322
prerender:
21802323
type: string
2324+
identity_instance_id:
2325+
type: string
2326+
x-nullable: true
21812327
siteSetup:
21822328
allOf:
21832329
- $ref: '#/definitions/site'
@@ -3007,6 +3153,74 @@ definitions:
30073153
properties:
30083154
slides:
30093155
type: string
3156+
identityAppMetadata:
3157+
type: object
3158+
additionalProperties: true
3159+
properties:
3160+
provider:
3161+
type: string
3162+
roles:
3163+
type: array
3164+
items:
3165+
type: string
3166+
identityUserMetadata:
3167+
type: object
3168+
additionalProperties: true
3169+
properties:
3170+
full_name:
3171+
type: string
3172+
identityUser:
3173+
type: object
3174+
properties:
3175+
id:
3176+
type: string
3177+
aud:
3178+
type: string
3179+
role:
3180+
type: string
3181+
email:
3182+
type: string
3183+
format: email
3184+
confirmed_at:
3185+
type: string
3186+
format: dateTime
3187+
invited_at:
3188+
type: string
3189+
format: dateTime
3190+
confirmation_sent_at:
3191+
type: string
3192+
format: dateTime
3193+
recovery_sent_at:
3194+
type: string
3195+
format: dateTime
3196+
new_email:
3197+
type: string
3198+
format: email
3199+
email_change_sent_at:
3200+
type: string
3201+
format: dateTime
3202+
last_sign_in_at:
3203+
type: string
3204+
format: dateTime
3205+
app_metadata:
3206+
$ref: '#/definitions/identityAppMetadata'
3207+
user_metadata:
3208+
$ref: '#/definitions/identityUserMetadata'
3209+
created_at:
3210+
type: string
3211+
format: dateTime
3212+
updated_at:
3213+
type: string
3214+
format: dateTime
3215+
required:
3216+
- id
3217+
- aud
3218+
- role
3219+
- email
3220+
- app_metadata
3221+
- user_metadata
3222+
- created_at
3223+
- updated_at
30103224
error:
30113225
type: object
30123226
required:
@@ -3079,6 +3293,9 @@ x-tagGroups:
30793293
tags:
30803294
- form
30813295
- submission
3296+
- name: Identity
3297+
tags:
3298+
- identity
30823299
- name: Split tests
30833300
tags:
30843301
- splitTest

0 commit comments

Comments
 (0)