Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update users endpoint to v2 #131

Draft
wants to merge 11 commits into
base: main
Choose a base branch
from
41 changes: 23 additions & 18 deletions mint.json
Original file line number Diff line number Diff line change
Expand Up @@ -455,9 +455,23 @@
]
},
{
"group": "User endpoints",
"group": "Annotation endpoints",
"pages": [
"restapi/endpoints/getCurrentUser"
"restapi/endpoints/getAnnotations",
"restapi/endpoints/getAnnotation",
"restapi/endpoints/createAnnotation",
"restapi/endpoints/updateAnnotation",
"restapi/endpoints/deleteAnnotation"
]
},
{
"group": "API token endpoints",
"pages": [
"restapi/endpoints/getTokens",
"restapi/endpoints/getToken",
"restapi/endpoints/createToken",
"restapi/endpoints/regenerateToken",
"restapi/endpoints/deleteToken"
]
},
{
Expand All @@ -475,23 +489,14 @@
]
},
{
"group": "Annotation endpoints",
"pages": [
"restapi/endpoints/getAnnotations",
"restapi/endpoints/getAnnotation",
"restapi/endpoints/createAnnotation",
"restapi/endpoints/updateAnnotation",
"restapi/endpoints/deleteAnnotation"
]
},
{
"group": "API token endpoints",
"group": "User endpoints",
"pages": [
"restapi/endpoints/getTokens",
"restapi/endpoints/getToken",
"restapi/endpoints/createToken",
"restapi/endpoints/regenerateToken",
"restapi/endpoints/deleteToken"
"restapi/endpoints/getCurrentUser",
"restapi/endpoints/getUsers",
"restapi/endpoints/getUser",
"restapi/endpoints/createUser",
"restapi/endpoints/updateUser",
"restapi/endpoints/deleteUser"
]
}
],
Expand Down
4 changes: 4 additions & 0 deletions restapi/endpoints/createUser.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: Create user
openapi: "v2 post /users"
---
4 changes: 4 additions & 0 deletions restapi/endpoints/deleteUser.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: Delete user
openapi: "v2 delete /users/{id}"
---
2 changes: 1 addition & 1 deletion restapi/endpoints/getCurrentUser.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
---
title: Retrieve current user
openapi: "v1 get /user"
openapi: "v2 get /user"
---
4 changes: 4 additions & 0 deletions restapi/endpoints/getUser.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: Retrieve user
openapi: "v2 get /users/{id}"
---
4 changes: 4 additions & 0 deletions restapi/endpoints/getUsers.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: List all users
openapi: "v2 get /users"
---
10 changes: 10 additions & 0 deletions restapi/endpoints/updateUser.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: Update user
openapi: "v2 put /users/{id}"
---

<Warning>
Using this endpoint, you can change the name of your own user. Authorize the request with a [personal access token (PAT)](/reference/tokens).

You cannot change the names of other users, you cannot change other properties than your name, and you cannot use an API token to authorize the request.
tothmano marked this conversation as resolved.
Show resolved Hide resolved
</Warning>
Loading