Skip to content
This repository has been archived by the owner on Mar 17, 2023. It is now read-only.

[NEW] Docs for new oAuth endpoints #1518

Merged
merged 7 commits into from
Dec 20, 2019
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
Prev Previous commit
Next Next commit
Rename endpoints
  • Loading branch information
MarcosSpessatto committed Dec 19, 2019
commit 7f9c82b012d8e72e63d35d33806e6db9d44fc8c8
4 changes: 2 additions & 2 deletions developer-guides/rest-api/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -227,8 +227,8 @@ When calling a production Rocket.Chat server, ensure it is running via HTTPS and

| Url | Short Description | Details Page |
| :------------------------------ | :---------------------------------------- | :-------------------------- |
| `/api/v1/oauthApps.getOne` | Retrieves an OAuth App by id or client id.| [Link](oauthapps/getone/) |
| `/api/v1/oauthApps.list` | Retrieves a list of OAuth Apps. | [Link](oauthapps/list) |
| `/api/v1/oauth-apps.getOne` | Retrieves an OAuth App by id or client id.| [Link](oauthapps/getone/) |
| `/api/v1/oauth-apps.list` | Retrieves a list of OAuth Apps. | [Link](oauthapps/list) |

### Permissions

Expand Down
4 changes: 2 additions & 2 deletions developer-guides/rest-api/oauthapps/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@

| Url | Short Description | Details Page |
| :------------------------------ | :---------------------------------------- | :---------------- |
| `/api/v1/oauthApps.getOne` | Retrieves an OAuth App by id or client id.| [Link](getone/) |
| `/api/v1/oauthApps.list` | Retrieves a list of OAuth Apps. | [Link](list) |
| `/api/v1/oauth-apps.getOne` | Retrieves an OAuth App by id or client id.| [Link](getone/) |
| `/api/v1/oauth-apps.list` | Retrieves a list of OAuth Apps. | [Link](list) |
4 changes: 2 additions & 2 deletions developer-guides/rest-api/oauthapps/getone/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Retrieves an OAuth App by id or client id

| URL | Requires Auth | HTTP Method |
| :--- | :--- | :--- |
| `/api/v1/oauthApps.getOne` | `yes` | `GET` |
| `/api/v1/oauth-apps.getOne` | `yes` | `GET` |

## Query Parameters

Expand All @@ -18,7 +18,7 @@ Retrieves an OAuth App by id or client id
```bash
curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
-H "X-User-Id: aobEdbYhXfu5hkeqG" \
http://localhost:3000/api/v1/oauthApps.getOne?appId=jn32kjnnd0943j4njk
http://localhost:3000/api/v1/oauth-apps.getOne?appId=jn32kjnnd0943j4njk
```

## Example Result
Expand Down
4 changes: 2 additions & 2 deletions developer-guides/rest-api/oauthapps/list/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@ Retrieves all OAuth Apss

| URL | Requires Auth | HTTP Method |
| :--- | :--- | :--- |
| `/api/v1/oauthApps.list` | `yes` | `GET` |
| `/api/v1/oauth-apps.list` | `yes` | `GET` |

## Example

```bash
curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
-H "X-User-Id: aobEdbYhXfu5hkeqG" \
http://localhost:3000/api/v1/oauthApps.list
http://localhost:3000/api/v1/oauth-apps.list
```

## Example Result
Expand Down