Chromium Code Reviews Chromium Code Reviews
Issue 1774913006:
Add error codes to server protocol (#25958). (Closed)
Base URL: git@github.com:dart-lang/sdk.git@master| OLD | NEW |
|---|---|
| 1 <!doctype html> | 1 <!doctype html> |
| 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.14.0</version></h1> | 9 <h1 style="color:#999999">Version <version>1.14.0</version></h1> |
|
Brian Wilkerson
2016/03/09 01:15:01
Need to bump the version (so that clients can tell
pquitslund
2016/03/09 18:42:45
Done.
| |
| 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 2061 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... | |
| 2081 </field> | 2081 </field> |
| 2082 <field name="correction" optional="true"> | 2082 <field name="correction" optional="true"> |
| 2083 <ref>String</ref> | 2083 <ref>String</ref> |
| 2084 <p> | 2084 <p> |
| 2085 The correction message to be displayed for this error. The | 2085 The correction message to be displayed for this error. The |
| 2086 correction message should indicate how the user can fix | 2086 correction message should indicate how the user can fix |
| 2087 the error. The field is omitted if there is no correction | 2087 the error. The field is omitted if there is no correction |
| 2088 message associated with the error code. | 2088 message associated with the error code. |
| 2089 </p> | 2089 </p> |
| 2090 </field> | 2090 </field> |
| 2091 <field name="code"> | |
| 2092 <ref>String</ref> | |
| 2093 <p> | |
| 2094 The name, as a string, of the error code associated with this erro r. | |
| 2095 </p> | |
| 2096 </field> | |
| 2091 <field name="hasFix" optional="true"> | 2097 <field name="hasFix" optional="true"> |
| 2092 <ref>bool</ref> | 2098 <ref>bool</ref> |
| 2093 <p> | 2099 <p> |
| 2094 A hint to indicate to interested clients that this error has | 2100 A hint to indicate to interested clients that this error has |
| 2095 an associated fix (or fixes). The absence of this field implies | 2101 an associated fix (or fixes). The absence of this field implies |
| 2096 there are not known to be fixes. Note that since the operation | 2102 there are not known to be fixes. Note that since the operation |
| 2097 to calculate whether fixes apply needs to be performant it is | 2103 to calculate whether fixes apply needs to be performant it is |
| 2098 possible that complicated tests will be skipped and a false | 2104 possible that complicated tests will be skipped and a false |
| 2099 negative returned. For this reason, this attribute should be | 2105 negative returned. For this reason, this attribute should be |
| 2100 treated as a "hint". Despite the possibility of false negatives, | 2106 treated as a "hint". Despite the possibility of false negatives, |
| (...skipping 2391 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... | |
| 4492 This section contains a list of all of the errors that are | 4498 This section contains a list of all of the errors that are |
| 4493 produced by the server and the data that is returned with each. | 4499 produced by the server and the data that is returned with each. |
| 4494 </p> | 4500 </p> |
| 4495 <p> | 4501 <p> |
| 4496 TBD | 4502 TBD |
| 4497 </p> | 4503 </p> |
| 4498 <h2 class="domain"><a name="index">Index</a></h2> | 4504 <h2 class="domain"><a name="index">Index</a></h2> |
| 4499 <index></index> | 4505 <index></index> |
| 4500 </body> | 4506 </body> |
| 4501 </html> | 4507 </html> |
| OLD | NEW |
