Skip to content

Commit cb38467

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

File tree

1 file changed

+219
-0
lines changed

1 file changed

+219
-0
lines changed

swagger.yml

+219
Original file line numberDiff line numberDiff line change
@@ -213,6 +213,154 @@ 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+
responses:
221+
'200':
222+
description: OK
223+
schema:
224+
type: array
225+
items:
226+
$ref: '#/definitions/serviceInstance'
227+
default:
228+
$ref: '#/responses/error'
229+
/sites/{site_id}/identity/{identity_instance_id}/users:
230+
get:
231+
operationId: listSiteUsers
232+
tags: [identity]
233+
parameters:
234+
- name: site_id
235+
type: string
236+
in: path
237+
required: true
238+
- name: identity_instance_id
239+
type: string
240+
in: path
241+
required: true
242+
- $ref: '#/parameters/page'
243+
- $ref: '#/parameters/perPage'
244+
- name: sort
245+
schema:
246+
type: string
247+
in: query
248+
- name: filter
249+
schema:
250+
type: string
251+
in: query
252+
responses:
253+
'200':
254+
description: OK
255+
schema:
256+
type: array
257+
items:
258+
$ref: '#/definitions/identity_user'
259+
default:
260+
$ref: '#/responses/error'
261+
/sites/{site_id}/identity/{identity_instance_id}/users/{user_id}:
262+
get:
263+
operationId: getSiteUser
264+
tags: [identity]
265+
parameters:
266+
- name: site_id
267+
type: string
268+
in: path
269+
required: true
270+
- name: identity_instance_id
271+
type: string
272+
in: path
273+
required: true
274+
- name: user_id
275+
type: string
276+
in: path
277+
required: true
278+
responses:
279+
'200':
280+
description: OK
281+
schema:
282+
$ref: '#/definitions/identityUser'
283+
default:
284+
$ref: '#/responses/error'
285+
put:
286+
operationId: updateSiteUser
287+
tags: [identity]
288+
consumes:
289+
- application/json
290+
parameters:
291+
- name: site_id
292+
type: string
293+
in: path
294+
required: true
295+
- name: identity_instance_id
296+
type: string
297+
in: path
298+
required: true
299+
- name: user_id
300+
type: string
301+
in: path
302+
required: true
303+
- name: aud
304+
in: body
305+
schema:
306+
type: string
307+
- name: role
308+
in: body
309+
schema:
310+
type: string
311+
- name: email
312+
in: body
313+
schema:
314+
type: string
315+
format: email
316+
- name: password
317+
in: body
318+
schema:
319+
type: string
320+
format: password
321+
- name: confirm
322+
in: body
323+
schema:
324+
type: boolean
325+
- name: user_metadata
326+
in: body
327+
schema:
328+
$ref: '#/definitions/identityAppMetadata'
329+
- name: app_metadata
330+
in: body
331+
schema:
332+
$ref: '#/definitions/identityUserMetadata'
333+
responses:
334+
'200':
335+
description: OK
336+
schema:
337+
$ref: '#/definitions/identityUser'
338+
default:
339+
$ref: '#/responses/error'
340+
delete:
341+
operationId: deleteSiteUser
342+
tags: [identity]
343+
parameters:
344+
- name: site_id
345+
type: string
346+
in: path
347+
required: true
348+
- name: identity_instance_id
349+
type: string
350+
in: path
351+
required: true
352+
- name: user_id
353+
type: string
354+
in: path
355+
required: true
356+
responses:
357+
'200':
358+
description: OK
359+
schema:
360+
type: object
361+
properties: []
362+
default:
363+
$ref: '#/responses/error'
216364
/sites/{site_id}/submissions:
217365
get:
218366
operationId: listSiteSubmissions
@@ -3007,6 +3155,74 @@ definitions:
30073155
properties:
30083156
slides:
30093157
type: string
3158+
identityAppMetadata:
3159+
type: object
3160+
additionalProperties: true
3161+
properties:
3162+
provider:
3163+
type: string
3164+
roles:
3165+
type: array
3166+
items:
3167+
type: string
3168+
identityUserMetadata:
3169+
type: object
3170+
additionalProperties: true
3171+
properties:
3172+
full_name:
3173+
type: string
3174+
identityUser:
3175+
type: object
3176+
properties:
3177+
id:
3178+
type: string
3179+
aud:
3180+
type: string
3181+
role:
3182+
type: string
3183+
email:
3184+
type: string
3185+
format: email
3186+
confirmed_at:
3187+
type: string
3188+
format: dateTime
3189+
invited_at:
3190+
type: string
3191+
format: dateTime
3192+
confirmation_sent_at:
3193+
type: string
3194+
format: dateTime
3195+
recovery_sent_at:
3196+
type: string
3197+
format: dateTime
3198+
new_email:
3199+
type: string
3200+
format: email
3201+
email_change_sent_at:
3202+
type: string
3203+
format: dateTime
3204+
last_sign_in_at:
3205+
type: string
3206+
format: dateTime
3207+
app_metadata:
3208+
$ref: '#/definitions/identityAppMetadata'
3209+
user_metadata:
3210+
$ref: '#/definitions/identityUserMetadata'
3211+
created_at:
3212+
type: string
3213+
format: dateTime
3214+
updated_at:
3215+
type: string
3216+
format: dateTime
3217+
required:
3218+
- id
3219+
- aud
3220+
- role
3221+
- email
3222+
- app_metadata
3223+
- user_metadata
3224+
- created_at
3225+
- updated_at
30103226
error:
30113227
type: object
30123228
required:
@@ -3079,6 +3295,9 @@ x-tagGroups:
30793295
tags:
30803296
- form
30813297
- submission
3298+
- name: Identity
3299+
tags:
3300+
- identity
30823301
- name: Split tests
30833302
tags:
30843303
- splitTest

0 commit comments

Comments
 (0)