Skip to content

Commit

Permalink
format json
Browse files Browse the repository at this point in the history
  • Loading branch information
gkorland committed Sep 9, 2024
1 parent 0dfc251 commit 4bf4ef8
Showing 1 changed file with 1 addition and 8 deletions.
9 changes: 1 addition & 8 deletions integration/rest.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,7 @@ parent: "integration"

| Request Name | Request Endpoint | Request Method | Request Headers | Request Parameters | Body | Successful Response | Description|
| ------------- | ---------------- | -------------- | --------------- | ------------------ | ---- | ------------------- | ---------- |
| Login | [/api/auth/providers](http://localhost:3000/api/auth/providers) | GET | None | None | None | Status Code: 200

```json
{ "credentials": {"id": "credentials","name": "Credentials","type": "credentials","signinUrl": "http://localhost:3000/api/auth/signin/credentials","callbackUrl": "http://localhost:3000/api/auth/callback/credentials"
}}
```

| This request is used for user authentication. |
| Login | [/api/auth/providers](http://localhost:3000/api/auth/providers) | GET | None | None | None | Status Code: 200 <pre><code>{<br>"credentials": {<br>"id": "credentials",<br>"name": "Credentials",<br>"type": "credentials",<br>"signinUrl": "http://localhost:3000/api/auth/signin/credentials",<br>"callbackUrl": "http://localhost:3000/api/auth/callback/credentials"<br>}<br>}</pre></code> | This request is used for user authentication. |
| Logout | [/api/auth/signout](http://localhost:3000/api/auth/signout) | POST | Content-Type: application/x-www-form-urlencoded | None | x-www-form-urlencoded:<br>1- Key: csrfToken – value: insert csrfToken<br>2- Key: callbackUrl – value: /login<br>3- Key: json - value: true | Status Code: 200<br>{<br>"url": "http://localhost:3000/api/auth/signout?csrf=true"<br>} | <br>This request is used to sign out users, ending their current authenticated session and logging them out of the system |
| Modify config role | [/api/graph?config=MAX_QUEUED_QUERIES&value=10](http://localhost:3000/api/graph?config=MAX_QUEUED_QUERIES&value=10) | POST | Authorization: Cookie | 1\. Key: config - Value: MAX_QUEUED_QUERIES (required)<br>2\. Key: value - Value: A number (required) | None | Status Code: 200<br>Response Body:<br>{ "config": "OK" } | This request is used to set a configuration value for MAX_QUEUED_QUERIES. It accepts a number as the value for the configuration and requires authorization via a cookie in the headers. |
| Get config role value | [/api/graph?config=MAX_QUEUED_QUERIES](http://localhost:3000/api/graph?config=MAX_QUEUED_QUERIES) | GET | Authorization: Cookie | 1\. Key: config - Value: MAX_QUEUED_QUERIES (required)<br>2\. Key: value - Value: A number (required) | None | Status code: 200<br>{"config": [ "MAX_QUEUED_QUERIES",25 ]} | This request is used to get a configuration value for MAX_QUEUED_QUERIES. It accepts a number as the value for the configuration and requires authorization via a cookie in the headers. |
Expand Down

0 comments on commit 4bf4ef8

Please sign in to comment.