| Shawn O. Pearce | 14760b7 | 2010-07-19 09:44:46 -0700 | [diff] [blame] | 1 | Gerrit Code Review - JSON Data |
| 2 | ============================== |
| 3 | |
| 4 | Some commands produce JSON data streams intended for other |
| 5 | applications to consume. The structures are documented below. |
| 6 | Note that any field may be missing in the JSON messages, so consumers |
| 7 | of this JSON stream should deal with that appropriately. |
| 8 | |
| 9 | [[change]] |
| 10 | change |
| 11 | ------ |
| 12 | The Gerrit change being reviewed, or that was already reviewed. |
| 13 | |
| 14 | project:: Project path in Gerrit |
| 15 | |
| 16 | branch:: Branch name within project |
| 17 | |
| 18 | topic:: Topic name specified by the uploader for this change series |
| 19 | |
| 20 | id:: Change identifier, as scraped out of the Change-Id field in |
| 21 | the commit message, or as assigned by the server if it was missing. |
| 22 | |
| 23 | number:: Change number (deprecated) |
| 24 | |
| 25 | subject:: Description of change |
| 26 | |
| 27 | owner:: Owner in <<account,account attribute>> |
| 28 | |
| 29 | url:: Canonical URL to reach this change |
| 30 | |
| 31 | lastUpdated:: Time in seconds since the UNIX epoch when this change |
| 32 | was last updated. |
| 33 | |
| 34 | sortKey:: Internal key used to sort changes, based on lastUpdated. |
| 35 | |
| 36 | open:: Boolean indicating if the change is still open for review. |
| 37 | |
| 38 | status:: Current state of this change. |
| 39 | |
| 40 | NEW;; Change is still being reviewed. |
| 41 | |
| 42 | SUBMITTED;; Change has been submitted and is in the merge queue. |
| 43 | It may be waiting for one or more dependencies. |
| 44 | |
| 45 | MERGED;; Change has been merged to its branch. |
| 46 | |
| 47 | ABANDONED;; Change was abandoned by its owner or administrator. |
| 48 | |
| 49 | trackingIds:: Issue tracking system links in |
| 50 | <<trackingid,trackingid attribute>>, scraped out of the commit |
| 51 | message based on the server's |
| 52 | link:config-gerrit.html#trackingid[trackingid] sections. |
| 53 | |
| 54 | currentPatchSet:: Current <<patchset,patchset attribute>>. |
| 55 | |
| 56 | patchSets:: All <<patchset,patchset attribute>> for this change. |
| 57 | |
| 58 | [[trackingid]] |
| 59 | trackingid |
| 60 | ---------- |
| 61 | A link to an issue tracking system. |
| 62 | |
| 63 | system:: Name of the system. This comes straight from the |
| 64 | gerrit.config file. |
| 65 | |
| 66 | id:: Id number as scraped out of the commit message. |
| 67 | |
| 68 | [[account]] |
| 69 | account |
| 70 | ------- |
| 71 | A user account. |
| 72 | |
| 73 | name:: User's full name, if configured. |
| 74 | |
| 75 | email:: User's preferred email address. |
| 76 | |
| 77 | [[patchset]] |
| 78 | patchset |
| 79 | -------- |
| 80 | Refers to a specific patchset within a <<change,change>>. |
| 81 | |
| 82 | number:: The patchset number. |
| 83 | |
| 84 | revision:: Git commit for this patchset. |
| 85 | |
| 86 | ref:: Git reference pointing at the revision. This reference is |
| 87 | available through the Gerrit Code Review server's Git interface |
| 88 | for the containing change. |
| 89 | |
| 90 | uploader:: Uploader of the patch set in <<account,account attribute>>. |
| 91 | |
| 92 | approvals:: The <<approval,approval attribute>> granted. |
| 93 | |
| 94 | [[approval]] |
| 95 | approval |
| 96 | -------- |
| 97 | Records the code review approval granted to a patch set. |
| 98 | |
| 99 | type:: Internal name of the approval given. |
| 100 | |
| 101 | description:: Human readable category of the approval. |
| 102 | |
| 103 | value:: Value assigned by the approval, usually a numerical score. |
| 104 | |
| 105 | grantedOn:: Time in seconds since the UNIX epoch when this approval |
| 106 | was added or last updated. |
| 107 | |
| 108 | by:: Reviewer of the patch set in <<account,account attribute>>. |
| 109 | |
| 110 | SEE ALSO |
| 111 | -------- |
| 112 | |
| 113 | * link:cmd-stream-events.html[gerrit stream-events] |
| 114 | * link:cmd-query.html[gerrit query] |
| 115 | |
| 116 | GERRIT |
| 117 | ------ |
| 118 | Part of link:index.html[Gerrit Code Review] |
