chore(docs): Refactor API Reference (#1883)
This commit is contained in:
47
docs/api/admin/paths/invites.yaml
Normal file
47
docs/api/admin/paths/invites.yaml
Normal file
@@ -0,0 +1,47 @@
|
||||
post:
|
||||
operationId: PostInvites
|
||||
summary: Create an Invite
|
||||
description: Creates an Invite and triggers an 'invite' created event
|
||||
x-authenticated: true
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
required:
|
||||
- user
|
||||
- role
|
||||
properties:
|
||||
user:
|
||||
description: The email for the user to be created.
|
||||
type: string
|
||||
format: email
|
||||
role:
|
||||
description: The role of the user to be created.
|
||||
type: string
|
||||
enum:
|
||||
- admin
|
||||
- member
|
||||
- developer
|
||||
tags:
|
||||
- Invite
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
get:
|
||||
operationId: GetInvites
|
||||
summary: Lists all Invites
|
||||
description: Lists all Invites
|
||||
x-authenticated: true
|
||||
tags:
|
||||
- Invite
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
properties:
|
||||
invites:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../components/schemas/invite.yaml
|
||||
Reference in New Issue
Block a user