Remove or make a note about Runners scopes in API documentation

XMLWordPrintable

    • Severity 3 - Minor
    • 62

      Issue Summary

      Currently, if you go to the Bitbucket Cloud REST API authentication page, you'll see the 2 scopes about Runners: - https://developer.atlassian.com/cloud/bitbucket/rest/intro/#runner

      runner

      Gives read-only access to pipelines runners setup against a workspace or repository.

      runner:write

      Gives write access to create/edit/disable/delete pipelines runners setup against a workspace or repository.

      Unfortunately, we don't have Runners API endpoints at the moment (See feature request here BCLOUD-21309).

      Hence, the scopes are confusing.

      Steps to Reproduce

      1. Go this link - https://developer.atlassian.com/cloud/bitbucket/rest/intro/#runner
      2. Check the scope "runner:write" which mentions the ability to create/edit/disable/delete pipelines runners

      Expected Results

      We could either remove those scopes for now or at least add a note there that it's only for internal use.

      Actual Results

      The documentation is confusing customers as this implies that there are Runners API endpoints.

      Workaround

      No workaround at the moment since there are no Runners API endpoints yet but please do watch over the other ticket for now - BCLOUD-21309

            Assignee:
            Unassigned
            Reporter:
            Mark C
            Votes:
            3 Vote for this issue
            Watchers:
            2 Start watching this issue

              Created:
              Updated: