| OLD | NEW |
|---|
| 1 <html><head> | 1 <html><head> |
| 2 <meta charset="UTF-8"> | 2 <meta charset="UTF-8"> |
| 3 <title>Analysis Server API Specification</title> | 3 <title>Analysis Server API Specification</title> |
| 4 <style>body { | 4 <style>body { |
| 5 font-family: sans-serif, serif; | 5 font-family: sans-serif, serif; |
| 6 padding-left: 5%; | 6 padding-left: 5%; |
| 7 padding-right: 5%; | 7 padding-right: 5%; |
| 8 } | 8 } |
| 9 h1 { | 9 h1 { |
| 10 text-align: center; | 10 text-align: center; |
| (...skipping 25 matching lines...) Expand all Loading... |
| 36 } | 36 } |
| 37 dt.request { | 37 dt.request { |
| 38 font-weight: bold; | 38 font-weight: bold; |
| 39 } | 39 } |
| 40 dt.typeDefinition { | 40 dt.typeDefinition { |
| 41 font-weight: bold; | 41 font-weight: bold; |
| 42 } | 42 } |
| 43 </style></head> | 43 </style></head> |
| 44 <body> | 44 <body> |
| 45 <h1>Analysis Server API Specification</h1> | 45 <h1>Analysis Server API Specification</h1> |
| 46 <h1 style="color:#999999">Version 1.2.0</h1> | 46 <h1 style="color:#999999">Version 1.3.0</h1> |
| 47 <p> | 47 <p> |
| 48 This document contains a specification of the API provided by the | 48 This document contains a specification of the API provided by the |
| 49 analysis server. The API in this document is currently under | 49 analysis server. The API in this document is currently under |
| 50 development. Changes to the API will be accompanied by an update to the | 50 development. Changes to the API will be accompanied by an update to the |
| 51 protocol version number according to the principles of semantic | 51 protocol version number according to the principles of semantic |
| 52 versioning <a href="http://semver.org/">http://semver.org/</a>. | 52 versioning <a href="http://semver.org/">http://semver.org/</a>. |
| 53 </p> | 53 </p> |
| 54 <h2>Overview</h2> | 54 <h2>Overview</h2> |
| 55 <p> | 55 <p> |
| 56 The analysis server API is a bi-directional client-server | 56 The analysis server API is a bi-directional client-server |
| (...skipping 83 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 140 syntactic analysis is complete, and both syntactic and semantic | 140 syntactic analysis is complete, and both syntactic and semantic |
| 141 errors can be returned together at a later time. | 141 errors can be returned together at a later time. |
| 142 </p> | 142 </p> |
| 143 <p> | 143 <p> |
| 144 Each notification has two fields. The first field is the ‘event’ | 144 Each notification has two fields. The first field is the ‘event’ |
| 145 field, which identifies the kind of notification. The second | 145 field, which identifies the kind of notification. The second |
| 146 field is the ‘params’ field, whose structure is dependent on the | 146 field is the ‘params’ field, whose structure is dependent on the |
| 147 kind of notification being sent. The structure of this field is | 147 kind of notification being sent. The structure of this field is |
| 148 described with each notification. | 148 described with each notification. |
| 149 </p> | 149 </p> |
| 150 <p> |
| 151 In order to be backward compatible, clients should ignore fields that were |
| 152 not specified in the version of the API on which they were based. Clients |
| 153 should also use the server.getVersion request to test that the version of |
| 154 the server supports an API before using it. |
| 155 </p> |
| 150 <h3>Eventual Consistency</h3> | 156 <h3>Eventual Consistency</h3> |
| 151 <p> | 157 <p> |
| 152 TBD | 158 TBD |
| 153 </p> | 159 </p> |
| 154 <h3>Domains</h3> | 160 <h3>Domains</h3> |
| 155 <p> | 161 <p> |
| 156 For convenience, the API is divided into domains. Each domain is | 162 For convenience, the API is divided into domains. Each domain is |
| 157 specified in a separate section below: | 163 specified in a separate section below: |
| 158 </p> | 164 </p> |
| 159 <ul> | 165 <ul> |
| (...skipping 109 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 269 It is an error if any of the elements in the list are not | 275 It is an error if any of the elements in the list are not |
| 270 valid services. If there is an error, then the current | 276 valid services. If there is an error, then the current |
| 271 subscriptions will remain unchanged. | 277 subscriptions will remain unchanged. |
| 272 </p> | 278 </p> |
| 273 | 279 |
| 274 <h4>Parameters</h4><dl><dt class="field"><b><i>subscriptions ( List<<a
href="#type_ServerService">ServerService</a>> )</i></b></dt><dd> | 280 <h4>Parameters</h4><dl><dt class="field"><b><i>subscriptions ( List<<a
href="#type_ServerService">ServerService</a>> )</i></b></dt><dd> |
| 275 | 281 |
| 276 <p>A list of the services being subscribed to.</p> | 282 <p>A list of the services being subscribed to.</p> |
| 277 </dd></dl></dd></dl><h3>Notifications</h3><dl><dt class="notification"
>server.connected</dt><dd><div class="box"><pre>notification: { | 283 </dd></dl></dd></dl><h3>Notifications</h3><dl><dt class="notification"
>server.connected</dt><dd><div class="box"><pre>notification: { |
| 278 "event": "server.connected" | 284 "event": "server.connected" |
| 285 "params": { |
| 286 "<b>version</b>": String |
| 287 } |
| 279 }</pre></div> | 288 }</pre></div> |
| 280 <p> | 289 <p> |
| 281 Reports that the server is running. This notification is | 290 Reports that the server is running. This notification is |
| 282 issued once after the server has started running but before | 291 issued once after the server has started running but before |
| 283 any requests are processed to let the client know that it | 292 any requests are processed to let the client know that it |
| 284 started correctly. | 293 started correctly. |
| 285 </p> | 294 </p> |
| 286 <p> | 295 <p> |
| 287 It is not possible to subscribe to or unsubscribe from this | 296 It is not possible to subscribe to or unsubscribe from this |
| 288 notification. | 297 notification. |
| 289 </p> | 298 </p> |
| 290 </dd><dt class="notification">server.error</dt><dd><div class="box"><pre>n
otification: { | 299 |
| 300 <h4>Parameters</h4><dl><dt class="field"><b><i>version ( String )</i></b><
/dt><dd> |
| 301 |
| 302 <p>The version number of the analysis server.</p> |
| 303 </dd></dl></dd><dt class="notification">server.error</dt><dd><div clas
s="box"><pre>notification: { |
| 291 "event": "server.error" | 304 "event": "server.error" |
| 292 "params": { | 305 "params": { |
| 293 "<b>isFatal</b>": bool | 306 "<b>isFatal</b>": bool |
| 294 "<b>message</b>": String | 307 "<b>message</b>": String |
| 295 "<b>stackTrace</b>": String | 308 "<b>stackTrace</b>": String |
| 296 } | 309 } |
| 297 }</pre></div> | 310 }</pre></div> |
| 298 <p> | 311 <p> |
| 299 Reports that an unexpected error has occurred while | 312 Reports that an unexpected error has occurred while |
| 300 executing the server. This notification is not used for | 313 executing the server. This notification is not used for |
| (...skipping 3442 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 3743 <p> | 3756 <p> |
| 3744 This section contains a list of all of the errors that are | 3757 This section contains a list of all of the errors that are |
| 3745 produced by the server and the data that is returned with each. | 3758 produced by the server and the data that is returned with each. |
| 3746 </p> | 3759 </p> |
| 3747 <p> | 3760 <p> |
| 3748 TBD | 3761 TBD |
| 3749 </p> | 3762 </p> |
| 3750 | 3763 |
| 3751 | 3764 |
| 3752 </body></html> | 3765 </body></html> |
| OLD | NEW |
|---|
Chromium Code Reviews
Issue 943723002:
Return version with connected notification (Closed)
Base URL: https://dart.googlecode.com/svn/branches/bleeding_edge/dart