docs/config-rulebase-common: Fix links and update property docs * Add documentation for the escapedSubject property (change events). * Update list of valid statuses for a change: null is reported as an empty string and SUBMITTED doesn't seem to exist in Change.Status. * Correct the name for createdOn patch set property. Change-Id: Ie07b08634ef1973f15bb9a52bce935878c0d9c43
diff --git a/src/main/resources/Documentation/config-rulebase-common.md b/src/main/resources/Documentation/config-rulebase-common.md index 5a45364..b797d62 100644 --- a/src/main/resources/Documentation/config-rulebase-common.md +++ b/src/main/resources/Documentation/config-rulebase-common.md
@@ -316,8 +316,8 @@ : reason why the change has been abandoned. In addition to the above properties, the event also provides -properties for the abandoned [Change][common-properties-for-events-on-a-change], and -its most recent [Patch Set][common-properties-for-events-on-a-patch-set]. +properties for the abandoned [Change](#common-properties-for-events-on-a-change), and +its most recent [Patch Set](#common-properties-for-events-on-a-patch-set). ### ChangeMergedEvent @@ -337,8 +337,8 @@ : username of the user causing the merge of the change. In addition to the above properties, the event also provides -properties for the merged [Change][common-properties-for-events-on-a-change], and its -most recent [Patch Set][common-properties-for-events-on-a-patch-set]. +properties for the merged [Change](#common-properties-for-events-on-a-change), and its +most recent [Patch Set](#common-properties-for-events-on-a-patch-set). ### ChangeRestoredEvent @@ -361,8 +361,8 @@ : username of the user restoring the change. In addition to the above properties, the event also provides -properties for the restored [Change][common-properties-for-events-on-a-change], and it's -most recent [Patch Set][common-properties-for-events-on-a-patch-set]. +properties for the restored [Change](#common-properties-for-events-on-a-change), and it's +most recent [Patch Set](#common-properties-for-events-on-a-patch-set). ### CommentAddedEvent @@ -399,8 +399,8 @@ : `-2` In addition to the above properties, the event also provides -properties for the [Change][common-properties-for-events-on-a-change] the comment was -added for, and it's most recent [Patch Set][common-properties-for-events-on-a-patch-set]. +properties for the [Change](#common-properties-for-events-on-a-change) the comment was +added for, and it's most recent [Patch Set](#common-properties-for-events-on-a-patch-set). ### PatchSetCreatedEvent @@ -411,8 +411,8 @@ : `patchset-created` In addition to the above properties, the event also provides -properties for the uploaded [Patch Set][common-properties-for-events-on-a-patch-set], -and the [Change][common-properties-for-events-on-a-change] it belongs to. +properties for the uploaded [Patch Set](#common-properties-for-events-on-a-patch-set), +and the [Change](#common-properties-for-events-on-a-change) it belongs to. ### RefUpdatedEvent @@ -468,6 +468,10 @@ `changerUsername` : username of the user that changed the WIP state +In addition to the above properties, the event also provides +properties for the [Change](#common-properties-for-events-on-a-change) that changed +WIP state. + ### PrivateStateChangedEvent `event` @@ -485,6 +489,10 @@ `changerUsername` : username of the user that changed the private state +In addition to the above properties, the event also provides +properties for the [Change](#common-properties-for-events-on-a-change) that changed +private state. + ### Common properties for events on a change `branch` @@ -517,12 +525,14 @@ `subject` : first line of the change's most recent patch set's commit message. +`escapedSubject` +: same as `subject` but escaped using Java String rules. + `commitMessage` : full commit message of the most recent patch set `status` -: status of the change (`null`, `NEW`, `SUBMITTED`, `MERGED`, - or `ABANDONED` ) +: status of the change ("", `NEW`, `MERGED`, or `ABANDONED`) `topic` : name of the topic the change belongs to. @@ -544,7 +554,7 @@ `authorUsername` : username of this patch set's author. -`created-on` +`createdOn` : Timestamp of creation of the patch set (Seconds since 1st January 1970). `deletions`