opendev/gerrit
Code Issues Proposed changes

Fix stream-events documentation

Browse Source 
Some attributes contained in the events were not described, for a few
others the name was given in a wrong case.

Change-Id: I3b6b1f400a1b040ca9acfd57b20eef9d2d92aaa5
Signed-off-by: Edwin Kempin <edwin.kempin@sap.com>
This commit is contained in:
Edwin Kempin
2012-06-14 09:04:32 +02:00
parent 23c571899e
commit a19ff379fd
2 changed files with 22 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
Documentation/cmd-stream-events.txt
View File

@@ -41,9 +41,10 @@ EXAMPLES
SCHEMA
------
The JSON messages consist of nested objects referencing the *change*,
*patchset*, *account* involved, and other attributes as appropriate.
*patchSet*, *account* involved, and other attributes as appropriate.
The currently supported message types are *patchset-created*,
*comment-added*, *change-merged*, and *change-abandoned*.
*change-abandoned*, *change-restored*, *change-merged*,
*comment-added* and *ref-updated*.
Note that any field may be missing in the JSON messages, so consumers of
this JSON stream should deal with that appropriately.
@@ -56,7 +57,7 @@ type:: "patchset-created"
change:: link:json.html#change[change attribute]
patchset:: link:json.html#patchset[patchset attribute]
patchSet:: link:json.html#patchSet[patchSet attribute]
uploader:: link:json.html#account[account attribute]
@@ -66,27 +67,31 @@ type:: "change-abandoned"
change:: link:json.html#change[change attribute]
patchset:: link:json.html#patchset[patchset attribute]
patchSet:: link:json.html#patchSet[patchSet attribute]
abandoner:: link:json.html#account[account attribute]
reason:: Reason for abandoning the change.
Change Restored
^^^^^^^^^^^^^^^^
^^^^^^^^^^^^^^^
type:: "change-restored"
change:: link:json.html#change[change attribute]
patchset:: link:json.html#patchset[patchset attribute]
patchSet:: link:json.html#patchSet[patchSet attribute]
restorer:: link:json.html#account[account attribute]
reason:: Reason for restoring the change.
Change Merged
^^^^^^^^^^^^^
type:: "change-merged"
change:: link:json.html#change[change attribute]
patchset:: link:json.html#patchset[patchset attribute]
patchSet:: link:json.html#patchSet[patchSet attribute]
submitter:: link:json.html#account[account attribute]
@@ -96,10 +101,12 @@ type:: "comment-added"
change:: link:json.html#change[change attribute]
patchset:: link:json.html#patchset[patchset attribute]
patchSet:: link:json.html#patchSet[patchSet attribute]
author:: link:json.html#account[account attribute]
approvals:: All link:json.html#approval[approval attributes] granted.
comment:: Comment text author had written
Ref Updated
@@ -108,7 +115,7 @@ type:: "ref-updated"
submitter:: link:json.html#account[account attribute]
refUpdate:: link:json.html#refupdate[refupdate attribute]
refUpdate:: link:json.html#refUpdate[refUpdate attribute]
SEE ALSO