totole/services
1
0
Fork 0
mirror of https://github.com/kevin-DL/services.git synced 2026-01-15 12:34:44 +00:00
Code Issues Packages Projects Releases Wiki Activity

add invites example

Browse Source
This commit is contained in:
Asim Aslam
2021-05-05 12:04:07 +01:00
parent 0478c357d4
commit 5dd526ef56
2 changed files with 52 additions and 37 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
invites/README.md
View File

@@ -1,40 +1,6 @@
Manage and send user and group invites
# Invites Service
The invites services allows you to create and manage invites. Example usage:
The invites services allows you to create and manage invites for users and groups by providing invite codes.
```bash
> micro invites create --group_id=myawesomegroup --email=john@doe.com
{
"invite": {
"id": "fb3a3552-3c7b-4a18-a1f8-08ab56940862",
"group_id": "myawesomegroup",
"email": "john@doe.com",
"code": "86285587"
}
}
> micro invites list --group_id=fb3a3552-3c7b-4a18-a1f8-08ab56940862
{
"invites": [
{
"id": "fb3a3552-3c7b-4a18-a1f8-08ab56940862",
"group_id": "myawesomegroup",
"email": "john@doe.com",
"code": "86285587"
}
]
}
> micro invites read --code=86285587
{
"invite": {
"id": "fb3a3552-3c7b-4a18-a1f8-08ab56940862",
"group_id": "myawesomegroup",
"email": "john@doe.com",
"code": "86285587"
}
}
> micro invites delete --id=fb3a3552-3c7b-4a18-a1f8-08ab56940862
{}
```

49
invites/examples.json Normal file
View File

@@ -0,0 +1,49 @@
{
"create": [{
"title": "Create an invite",
"description": "Create an invite for a user for a group",
"request": {
"group_id": "mygroup",
"email": "john@doe.com"
},
"response": {
"invite": {
"id": "fb3a3552-3c7b-4a18-a1f8-08ab56940862",
"group_id": "mygroup",
"email": "john@doe.com",
"code": "86285587"
}
}
}],
"read": [{
"title": "Read an invite",
"description": "Read an invite by code",
"request": {
"code": "86285587"
},
"response": {
"invite": {
"id": "fb3a3552-3c7b-4a18-a1f8-08ab56940862",
"group_id": "mygroup",
"email": "john@doe.com",
"code": "86285587"
}
}
}],
"list": [{
"title": "List invites",
"description": "List invites for a group by id",
"request": {
"group_id": "mygroup"
},
"response": {
"invites": [{
"id": "fb3a3552-3c7b-4a18-a1f8-08ab56940862",
"group_id": "myawesomegroup",
"email": "john@doe.com",
"code": "86285587"
}]
}
}]
}