Merge branch 'stable-2.14' * stable-2.14: Set version to 2.14.4-SNAPSHOT Document that past assignees endpoint is only available with NoteDB Move get/set hashtag REST API documentation into correct section Change-Id: Ibb4fbf0be957737f96cf527502479f2659e8587e
diff --git a/Documentation/rest-api-changes.txt b/Documentation/rest-api-changes.txt index 714efd7..bf7bae4 100644 --- a/Documentation/rest-api-changes.txt +++ b/Documentation/rest-api-changes.txt
@@ -963,6 +963,8 @@ Returns a list of every user ever assigned to a change, in the order in which they were first assigned. +[NOTE] Past assignees are only available when NoteDb is enabled. + .Request ---- GET /changes/myProject~master~I8473b95934b5732ac55d26311a706c9c2bde9940/past_assignees HTTP/1.0 @@ -2348,6 +2350,80 @@ PUT /changes/myProject~master~I8473b95934b5732ac55d26311a706c9c2bde9940/unmute HTTP/1.0 ---- +[[get-hashtags]] +=== Get Hashtags +-- +'GET /changes/link:#change-id[\{change-id\}]/hashtags' +-- + +Gets the hashtags associated with a change. + +[NOTE] Hashtags are only available when NoteDb is enabled. + +.Request +---- + GET /changes/myProject~master~I8473b95934b5732ac55d26311a706c9c2bde9940/hashtags HTTP/1.0 +---- + +As response the change's hashtags are returned as a list of strings. + +.Response +---- + HTTP/1.1 200 OK + Content-Disposition: attachment + Content-Type: application/json; charset=UTF-8 + + )]}' + [ + "hashtag1", + "hashtag2" + ] +---- + +[[set-hashtags]] +=== Set Hashtags +-- +'POST /changes/link:#change-id[\{change-id\}]/hashtags' +-- + +Adds and/or removes hashtags from a change. + +[NOTE] Hashtags are only available when NoteDb is enabled. + +The hashtags to add or remove must be provided in the request body inside a +link:#hashtags-input[HashtagsInput] entity. + +.Request +---- + POST /changes/myProject~master~I8473b95934b5732ac55d26311a706c9c2bde9940/hashtags HTTP/1.0 + Content-Type: application/json; charset=UTF-8 + + { + "add" : [ + "hashtag3" + ], + "remove" : [ + "hashtag2" + ] + } +---- + +As response the change's hashtags are returned as a list of strings. + +.Response +---- + HTTP/1.1 200 OK + Content-Disposition: attachment + Content-Type: application/json; charset=UTF-8 + + )]}' + [ + "hashtag1", + "hashtag3" + ] +---- + + [[edit-endpoints]] == Change Edit Endpoints @@ -2717,78 +2793,6 @@ HTTP/1.1 204 No Content ---- -[[get-hashtags]] -=== Get Hashtags --- -'GET /changes/link:#change-id[\{change-id\}]/hashtags' --- - -Gets the hashtags associated with a change. - -[NOTE] Hashtags are only available when NoteDb is enabled. - -.Request ----- - GET /changes/myProject~master~I8473b95934b5732ac55d26311a706c9c2bde9940/hashtags HTTP/1.0 ----- - -As response the change's hashtags are returned as a list of strings. - -.Response ----- - HTTP/1.1 200 OK - Content-Disposition: attachment - Content-Type: application/json; charset=UTF-8 - - )]}' - [ - "hashtag1", - "hashtag2" - ] ----- - -[[set-hashtags]] -=== Set Hashtags --- -'POST /changes/link:#change-id[\{change-id\}]/hashtags' --- - -Adds and/or removes hashtags from a change. - -[NOTE] Hashtags are only available when NoteDb is enabled. - -The hashtags to add or remove must be provided in the request body inside a -link:#hashtags-input[HashtagsInput] entity. - -.Request ----- - POST /changes/myProject~master~I8473b95934b5732ac55d26311a706c9c2bde9940/hashtags HTTP/1.0 - Content-Type: application/json; charset=UTF-8 - - { - "add" : [ - "hashtag3" - ], - "remove" : [ - "hashtag2" - ] - } ----- - -As response the change's hashtags are returned as a list of strings. - -.Response ----- - HTTP/1.1 200 OK - Content-Disposition: attachment - Content-Type: application/json; charset=UTF-8 - - )]}' - [ - "hashtag1", - "hashtag3" - ] ----- [[reviewer-endpoints]] == Reviewer Endpoints