opendev/gerrit
Code Issues Proposed changes

rest-api-changes.txt: Move documentation of magic paths to #file-id

Browse Source 
The magic path names `/COMMIT_MSG` and `/MERGE_LIST` can be given
as input to multiple REST endpoints as the `file-id`.

Move the descriptions of those names from the List Files endpoint to
the file-id entity.

Bug: Issue 5855
Change-Id: I6ce3f909f27c51d149afd460b8e16dc9aef5dd34
This commit is contained in:
David Pursehouse
2017-03-27 10:58:05 +09:00
parent e41e3a64d8
commit 11badbbcc1
1 changed files with 13 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
Documentation/rest-api-changes.txt
View File

@@ -4264,24 +4264,12 @@ returned that describes the robot comment.
Lists the files that were modified, added or deleted in a revision.
In addition the following magic files are included:
* `/COMMIT_MSG`:
+
The commit message and headers with the parent commit(s), the author
information and the committer information.
* `/MERGE_LIST` (for merge commits only):
+
The list of commits that are being integrated into the destination
branch by submitting the merge commit.
.Request
----
GET /changes/myProject~master~I8473b95934b5732ac55d26311a706c9c2bde9940/revisions/674ac754f91e64a0efb8087e59a176484bd534d1/files/ HTTP/1.0
----
As result a map is returned that maps the file path to a list of
As result a map is returned that maps the link:#file-id[file path] to a list of
link:#file-info[FileInfo] entries. The entries in the map are
sorted by file path.
@@ -4926,6 +4914,18 @@ The name of the label.
=== \{file-id\}
The path of the file.
The following magic paths are supported:
* `/COMMIT_MSG`:
+
The commit message and headers with the parent commit(s), the author
information and the committer information.
* `/MERGE_LIST` (for merge commits only):
+
The list of commits that are being integrated into the destination
branch by submitting the merge commit.
[[fix-id]]
=== \{fix-id\}
UUID of a suggested fix.