-
Bug
-
Resolution: Fixed
-
Low
-
8.0.0, 8.1.0, 8.2.0, 8.0.1, 8.3.0, 7.21.0, 8.5.0, 8.6.0, 8.7.0, 8.8.0, 8.9.0, 8.10.0, 8.11.0, 8.12.0, 8.13.0, 8.14.0, 8.15.0
-
1
-
Severity 3 - Minor
-
0
-
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
- mentioned in
-
Page Loading...