Uploaded image for project: 'Jira Data Center'
  1. Jira Data Center
  2. JRASERVER-68798

Update REST API documentation to differentiate between username vs user_key

    XMLWordPrintable

Details

    • Suggestion
    • Resolution: Duplicate
    • None
    • REST API
    • None
    • 1
    • We collect Jira feedback from various sources, and we evaluate what we've collected when planning our product roadmap. To understand how this piece of feedback will be reviewed, see our Implementation of New Features Policy.

    Description

      The REST API documentation (e.g. https://docs.atlassian.com/software/jira/docs/api/REST/7.12.0/#api/2/project/) uses the terms user_key and username interchangeably. This leads to confusion because both values exist in the database schema and one value over the other fails.

      If the endpoints can't be changed to accept username (instead of userkey) then I'd also suggest careful use of the relevant term in each endpoint's description and a description of the difference earlier in the documentation.

      An explanatory sentence of this bug (JRASERVER-68189) on the REST documentation would be really useful or a more specific error message when the incorrect value is used.

      Attachments

        Issue Links

          Activity

            People

              Unassigned Unassigned
              ajean Andy J.
              Votes:
              1 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: