| OLD | NEW |
|---|
| 1 | 1 |
| 2 <html> | 2 <html> |
| 3 <head> | 3 <head> |
| 4 <meta charset="UTF-8"/> | 4 <meta charset="UTF-8"/> |
| 5 <title>Analysis Server API Specification</title> | 5 <title>Analysis Server API Specification</title> |
| 6 </head> | 6 </head> |
| 7 <body> | 7 <body> |
| 8 <h1>Analysis Server API Specification</h1> | 8 <h1>Analysis Server API Specification</h1> |
| 9 <h1 style="color:#999999">Version <version>1.2.0</version></h1> | 9 <h1 style="color:#999999">Version <version>1.3.0</version></h1> |
| 10 <p> | 10 <p> |
| 11 This document contains a specification of the API provided by the | 11 This document contains a specification of the API provided by the |
| 12 analysis server. The API in this document is currently under | 12 analysis server. The API in this document is currently under |
| 13 development. Changes to the API will be accompanied by an update to the | 13 development. Changes to the API will be accompanied by an update to the |
| 14 protocol version number according to the principles of semantic | 14 protocol version number according to the principles of semantic |
| 15 versioning <a href="http://semver.org/">http://semver.org/</a>. | 15 versioning <a href="http://semver.org/">http://semver.org/</a>. |
| 16 </p> | 16 </p> |
| 17 <h2>Overview</h2> | 17 <h2>Overview</h2> |
| 18 <p> | 18 <p> |
| 19 The analysis server API is a bi-directional client-server | 19 The analysis server API is a bi-directional client-server |
| (...skipping 83 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 103 syntactic analysis is complete, and both syntactic and semantic | 103 syntactic analysis is complete, and both syntactic and semantic |
| 104 errors can be returned together at a later time. | 104 errors can be returned together at a later time. |
| 105 </p> | 105 </p> |
| 106 <p> | 106 <p> |
| 107 Each notification has two fields. The first field is the ‘event’ | 107 Each notification has two fields. The first field is the ‘event’ |
| 108 field, which identifies the kind of notification. The second | 108 field, which identifies the kind of notification. The second |
| 109 field is the ‘params’ field, whose structure is dependent on the | 109 field is the ‘params’ field, whose structure is dependent on the |
| 110 kind of notification being sent. The structure of this field is | 110 kind of notification being sent. The structure of this field is |
| 111 described with each notification. | 111 described with each notification. |
| 112 </p> | 112 </p> |
| 113 <p> |
| 114 In order to be backward compatible, clients should ignore fields that were |
| 115 not specified in the version of the API on which they were based. Clients |
| 116 should also use the server.getVersion request to test that the version of |
| 117 the server supports an API before using it. |
| 118 </p> |
| 113 <h3>Eventual Consistency</h3> | 119 <h3>Eventual Consistency</h3> |
| 114 <p> | 120 <p> |
| 115 TBD | 121 TBD |
| 116 </p> | 122 </p> |
| 117 <h3>Domains</h3> | 123 <h3>Domains</h3> |
| 118 <p> | 124 <p> |
| 119 For convenience, the API is divided into domains. Each domain is | 125 For convenience, the API is divided into domains. Each domain is |
| 120 specified in a separate section below: | 126 specified in a separate section below: |
| 121 </p> | 127 </p> |
| 122 <ul> | 128 <ul> |
| (...skipping 95 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 218 <p> | 224 <p> |
| 219 Reports that the server is running. This notification is | 225 Reports that the server is running. This notification is |
| 220 issued once after the server has started running but before | 226 issued once after the server has started running but before |
| 221 any requests are processed to let the client know that it | 227 any requests are processed to let the client know that it |
| 222 started correctly. | 228 started correctly. |
| 223 </p> | 229 </p> |
| 224 <p> | 230 <p> |
| 225 It is not possible to subscribe to or unsubscribe from this | 231 It is not possible to subscribe to or unsubscribe from this |
| 226 notification. | 232 notification. |
| 227 </p> | 233 </p> |
| 234 <params> |
| 235 <field name="version"> |
| 236 <ref>String</ref> |
| 237 <p>The version number of the analysis server.</p> |
| 238 </field> |
| 239 </params> |
| 228 </notification> | 240 </notification> |
| 229 <notification event="error"> | 241 <notification event="error"> |
| 230 <p> | 242 <p> |
| 231 Reports that an unexpected error has occurred while | 243 Reports that an unexpected error has occurred while |
| 232 executing the server. This notification is not used for | 244 executing the server. This notification is not used for |
| 233 problems with specific requests (which are returned as part | 245 problems with specific requests (which are returned as part |
| 234 of the response) but is used for exceptions that occur while | 246 of the response) but is used for exceptions that occur while |
| 235 performing other tasks, such as analysis or preparing | 247 performing other tasks, such as analysis or preparing |
| 236 notifications. | 248 notifications. |
| 237 </p> | 249 </p> |
| (...skipping 3603 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 3841 <h2>Errors</h2> | 3853 <h2>Errors</h2> |
| 3842 <p> | 3854 <p> |
| 3843 This section contains a list of all of the errors that are | 3855 This section contains a list of all of the errors that are |
| 3844 produced by the server and the data that is returned with each. | 3856 produced by the server and the data that is returned with each. |
| 3845 </p> | 3857 </p> |
| 3846 <p> | 3858 <p> |
| 3847 TBD | 3859 TBD |
| 3848 </p> | 3860 </p> |
| 3849 </body> | 3861 </body> |
| 3850 </html> | 3862 </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