orb icon indicating copy to clipboard operation
orb copied to clipboard

Documentation: Insert API route to user authentication

Open manrodrigues opened this issue 3 years ago • 1 comments

The endpoint /tokens is not present on our current API documentation (https://getorb.io/api/fleet.html)

This endpoint is very important to use the rest of the API endpoints, since all others require authentication.

We need to insert it, already considering the new authentication using bearer token.

manrodrigues avatar Jun 28 '22 17:06 manrodrigues

We need to add one more statement pointing to mainflux's /token endpoint here: https://github.com/ns1labs/orb-website/blob/main/.github/workflows/ci.yml

 - name: redoc-cli user-token
        uses: seeebiii/redoc-cli-github-action@v10
        with:
          args: 'https://raw.githubusercontent.com/mainflux/mainflux/master/api/openapi/users.yml -o docs/api/token.html'

mclcavalcante avatar Sep 21 '22 22:09 mclcavalcante

I believe we should think of a workaround or reconsider adding that to our docs since it's maintained by an external project and may change without our supervision removing or adding unwanted stuff. Plus it contains other endpoints besides /token which is possibly unnecessary to show up on orb docs polluting user's view.

mclcavalcante avatar Sep 22 '22 18:09 mclcavalcante

I believe we should think of a workaround or reconsider adding that to our docs since it's maintained by an external project and may change without our supervision removing or adding unwanted stuff. Plus it contains other endpoints besides /token which is possibly unnecessary to show up on orb docs polluting user's view.

I strong believe that this is the best approach for us.

manrodrigues avatar Sep 23 '22 15:09 manrodrigues