Uploaded image for project: 'Bitbucket Data Center'
  1. Bitbucket Data Center
  2. BSERV-19003

Update the REST API documentation for streaming an archive of a repository regarding supported values for the "at" query parameter

XMLWordPrintable

      Issue Summary

      Update the REST API documentation for streaming an archive of a repository (GET /api/latest/projects/{projectKey}/repos/{repositorySlug}/archive regarding supported values for the "at" query parameter.

      The documentation currently mentions the following for the at query parameter:

      at

      The commit to stream an archive of; if not supplied, an archive of the default branch is streamed

      There is no mention of refs being supported for this parameter.

       

      But at the same time, under the filename parameter, it's indicated that branches or tags are supported:

      at=branchOrTag: <slug>-<branchOrTag>@<commit>.<format>; e.g. example-feature@bbb225f16e1.tar

      If the branch or tag is qualified (e.g. refs/heads/master, the short name (master) will be included in the filename
      If the branch or tag's short name includes slashes (e.g. release/4.6), they will be converted to hyphens in the filename (release-4.5)

       

      The at parameter description should be updated to mention that commits hashes and refs are supported for clarity.

       

      This is reproducible on Data Center: yes

      Steps to Reproduce

      N/A

      Expected Results

      Suggested change:

      at

      The commit hash or fully-qualified ref (e.g. refs/head/{refId} or refs/tags/{refId}) to stream an archive of; if not supplied, an archive of the default branch is streamed

      Actual Results

      There is no mention of refs in the at query parameter description.

      Workaround

      Currently there is no known workaround for this behavior. A workaround will be added here when available

              613b3afae942 Stepan Tsymbal
              jmariano@atlassian.com JP Mariano
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

                Created:
                Updated:
                Resolved: