Uploaded image for project: 'ListenBrainz'
  1. ListenBrainz
  2. LB-861

Add authorization section to API docs

    XMLWordPrintable

    Details

    • Type: Improvement
    • Status: Open
    • Priority: Normal
    • Resolution: Unresolved
    • Fix Version/s: None
    • Component/s: API
    • Labels:

      Description

      In the documentation of many of our endpoints, we have the following text in one form or the other:

      In order to query this endpoint, send a GET request with the token in the Authorization header.

      We should create an Authorization section in our docs and puts the instructions for authentication there. In the documentation of all our endpoints, we can then just link to it instead of repeating the same information.

        Attachments

          Activity

            People

            Assignee:
            Unassigned Unassigned
            Reporter:
            kartik1712 amCap1712
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Dates

              Created:
              Updated:

                Packages

                Version Package