From 6be12461dd2e8a17229fe442210fd020923d028a Mon Sep 17 00:00:00 2001 From: Henning Panke Date: Sat, 29 Jul 2023 15:05:23 +0200 Subject: [PATCH 1/2] Update "how to get a token" instructions (#139) --- CHANGELOG.md | 3 +++ src/api/client/v1/openapi.yaml | 6 ++++-- 2 files changed, 7 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 6191fa4..c908aa0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -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. diff --git a/src/api/client/v1/openapi.yaml b/src/api/client/v1/openapi.yaml index 8af62c2..714a992 100644 --- a/src/api/client/v1/openapi.yaml +++ b/src/api/client/v1/openapi.yaml @@ -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 service@realmq.com - * 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 From f9d50d666c3873878d01c1e3b57d5e751a556a08 Mon Sep 17 00:00:00 2001 From: Henning Panke Date: Sat, 29 Jul 2023 15:07:36 +0200 Subject: [PATCH 2/2] Fix typo in api documentation --- src/api/client/v1/openapi.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/api/client/v1/openapi.yaml b/src/api/client/v1/openapi.yaml index 714a992..0a9b05f 100644 --- a/src/api/client/v1/openapi.yaml +++ b/src/api/client/v1/openapi.yaml @@ -24,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**, **-**, **_**).