Skip to content

Commit

Permalink
fix typos
Browse files Browse the repository at this point in the history
  • Loading branch information
gkorland committed Sep 9, 2024
1 parent c09d7e4 commit 603cd04
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion integration/rest.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ parent: "integration"
| Create new user | [/api/user](http://localhost:3000/api/user) | POST | Authorization: Cookie | None | {<br>"username":"user",<br>"password":"password",<br>"role":"Read-Write"<br>} | Status Code: 201<br>{ "message": "User created"} | This request is used to create a new user with specified credentials. The required data, including the username, password, and role, is passed in the body of the request. Authorization is provided via a cookie in the headers. |
| Delete user | [/api/user](http://localhost:3000/api/user) | DELETE | Authorization: Cookie | None | {<br>"users":<br>[<br>{<br>"username":"userName",<br>"role":"Read-Write"<br>}<br>]<br>} | Status Code: 200<br>{<br>"message": "Users deleted"<br>} | This request is used to delete a user with specified credentials. The required data, including the username and role, is passed in the body of the request. Authorization is provided via a cookie in the headers. |
| Get All Users | [/api/user](http://localhost:3000/api/user) | GET | Authorization: Cookie | None | None | Status Code: 200<br>{<br>"result": [<br>{<br>"username": "default",<br>"role": "Admin",<br>"checked": false<br>}<br>]<br>} | This request retrieves a list of all users. Authorization is required via a cookie in the headers.<br><br><br><br><br><br><br> |
| Modify User Role | [/api/user/userName?role=Read-Only](http://localhost:3000/api/user/userName?role=Read-Only) | PATCH | Authorization: Cookie | 1\. Key: role - value: (e.g Admin, Read-Only, Read-Write)<br>2\. userName | None | Status Code: 200<br>{<br>"message": "Users created"<br>} | <br>This request updates the role of a specific user. The userName in the URL must be replaced with the actual username of the user whose role is being modified, and the role query parameter must be set to the desired role (e.g., Admin, Read-Only, Read-Write). Authorization is required via a cookie in the headers. |
| Modify User Role | [/api/user/userName?role=Read-Only](http://localhost:3000/api/user/userName?role=Read-Only) | PATCH | Authorization: Cookie | 1\. Key: role - value: (e.g. Admin, Read-Only, Read-Write)<br>2\. userName | None | Status Code: 200<br>{<br>"message": "Users created"<br>} | <br>This request updates the role of a specific user. The userName in the URL must be replaced with the actual username of the user whose role is being modified, and the role query parameter must be set to the desired role (e.g. Admin, Read-Only, Read-Write). Authorization is required via a cookie in the headers. |
| Create new Graph | [/api/graph/graphName?query=RETURN%201](http://localhost:3000/api/graph/graphName?query=RETURN%201) | GET | Authorization: Cookie | 1\. Graph name | None | Status Code: 200<br>{<br>"result": {<br>"metadata": [<br>"Cached execution: 0",<br>"Query internal execution time: 7.198178 milliseconds"<br>],<br>"data": [<br>{<br>"1": 1<br>}<br>]<br>}<br>} | This request creates a new graph with the specified name. Authorization is required via a cookie in the headers. The response includes metadata and data from the query execution. |
| Delete Graph | [/api/graph/graphName](http://localhost:3000/api/graph/graphName) | DELETE | Authorization: Cookie | 1\. Graph name | None | Status Code: 200<br>{<br>"message": "GraphName graph deleted"<br>} | This request deletes the graph with the specified name. Authorization is required via a cookie in the headers. The response confirms the deletion of the graph. |
| Get All Graphs | [/api/graph](http://localhost:3000/api/graph) | GET | Authorization: Cookie | None | None | Status Code: 200<br>{<br>"result": [ "graphName" ]<br>} | This request retrieves a list of all graphs. Authorization is required via a cookie in the headers. The response includes a list of graph names. |
Expand Down

0 comments on commit 603cd04

Please sign in to comment.