Skip to content

Update users endpoint to v2 #131

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.

Sign up for GitHub

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

Closed
wants to merge 11 commits into from
Closed

Update users endpoint to v2 #131

Show file tree
Hide file tree
Changes from 10 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
262745c
chore(swagger): Update v2 swagger
toppercodes Oct 23, 2024
c9cec0c
Add pages for users and update swagger version
toppercodes Oct 29, 2024
66cd184
Add pages for users and update swagger version
toppercodes Oct 29, 2024
88e50fd
Merge branch 'main' into v2-users
toppercodes Oct 29, 2024
5e6de26
add to mint
toppercodes Oct 29, 2024
a2c6c66
Merge branch 'v2-users' of github.com:axiomhq/docs into v2-users
toppercodes Oct 29, 2024
4a83425
Align wording
tothmano Oct 30, 2024
2f73305
Update getCurrentUser to use v2
toppercodes Oct 30, 2024
28cc4b1
Add disclaimer to update user
tothmano Nov 4, 2024
423e4ef
Merge branch 'main' into v2-users
tothmano Nov 4, 2024
171f6f5
Update restapi/endpoints/updateUser.mdx
tothmano Nov 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 23 additions & 18 deletions mint.json
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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.
</Warning>
Loading