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.

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

#139: Update "Getting started" section in client API documentation #150

Merged
merged 2 commits into from
Aug 1, 2023
Merged

#139: Update "Getting started" section in client API documentation #150

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6be1246
Update "how to get a token" instructions (#139)
baranga Jul 29, 2023
f9d50d6
Fix typo in api documentation
baranga Jul 29, 2023
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
3 changes: 3 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).
- Add support for upgraded verneMQ broker. This requires the acceptance of their [EULA](https://vernemq.com/end-user-license-agreement/),
by setting the environment variable `VERNEMQ_ACCEPT_EULA` needs to be set to `yes`.
- **BREAKING**: Secret `auth.token` is removed from list, detail & update responses of `/client/v1/auths/*`. ([#138])
- Updated "Getting started" section in client API documentation ([#139]).

[#139]: https://github.com/realmq/realmq-platform/issues/139

### Security
- Obfuscate sensitive information from api request logs.
Expand Down
8 changes: 5 additions & 3 deletions src/api/client/v1/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,10 @@ info:
description: |
## Getting Started

* Get in touch with us to get an account set up. You can do that by sending an email to <a href="mailto:[email protected]">[email protected]</a>
* We'll provide you with an `accessToken` with admin scope that allows you to create further users and access tokens.
* Create an account on [cloud.realmq.com](https://cloud.realmq.com).
* Open the _test_ project and navigate to the _Tokens_ section.
* Create a new token with the _admin_ scope.
* Copy the token and store it securely (it's not accessible after initial display)
* Paste the `accessToken` into the access token input field in the header of the api browser.
* There are two access groups (**scopes**). Every API endpoint has a description of what scopes are allowed to perform requests.
- **admin** Full management capabilities, administration capabilities
Expand All @@ -22,7 +24,7 @@ info:

## Custom Ids

* In order to provide optimal integratability, you can work with custom ids on channels, users, subscriptions and auth-tokens.
* In order to provide optimal integrability, you can work with custom ids on channels, users, subscriptions and auth-tokens.
* When creating these resources, you can pass an `id` property to the payload.
* You can then reference the resource by its custom id: eg. `GET /users/test-bot-1`.
* Valid ids must match `^[\w-]+$` (**alpha-numeric**, **-**, **_**).
Expand Down