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.10.0</version></h1> | 9 <h1 style="color:#999999">Version <version>1.11.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 2000 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
2020 </field> | 2020 </field> |
2021 <field name="correction" optional="true"> | 2021 <field name="correction" optional="true"> |
2022 <ref>String</ref> | 2022 <ref>String</ref> |
2023 <p> | 2023 <p> |
2024 The correction message to be displayed for this error. The | 2024 The correction message to be displayed for this error. The |
2025 correction message should indicate how the user can fix | 2025 correction message should indicate how the user can fix |
2026 the error. The field is omitted if there is no correction | 2026 the error. The field is omitted if there is no correction |
2027 message associated with the error code. | 2027 message associated with the error code. |
2028 </p> | 2028 </p> |
2029 </field> | 2029 </field> |
| 2030 <field name="hasFix" optional="true"> |
| 2031 <ref>bool</ref> |
| 2032 <p> |
| 2033 A hint to indicate to interested clients that this error has |
| 2034 an associated fix (or fixes). The absence of this field implies |
| 2035 there are not known to be fixes. Note that since the operation |
| 2036 to calculate whether fixes apply needs to be performant it is |
| 2037 possible that complicated tests will be skipped and a false |
| 2038 negative returned. For this reason, this attribute should be |
| 2039 treated as a "hint". Despite the possibility of false negatives, |
| 2040 no false positives should be returned. If a client sees this |
| 2041 flag set they can proceed with the confidence that there are in |
| 2042 fact associated fixes. |
| 2043 </p> |
| 2044 </field> |
2030 </object> | 2045 </object> |
2031 </type> | 2046 </type> |
2032 <type name="AnalysisErrorFixes"> | 2047 <type name="AnalysisErrorFixes"> |
2033 <p> | 2048 <p> |
2034 A list of fixes associated with a specific error | 2049 A list of fixes associated with a specific error |
2035 </p> | 2050 </p> |
2036 <object> | 2051 <object> |
2037 <field name="error"> | 2052 <field name="error"> |
2038 <ref>AnalysisError</ref> | 2053 <ref>AnalysisError</ref> |
2039 <p> | 2054 <p> |
(...skipping 2298 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
4338 This section contains a list of all of the errors that are | 4353 This section contains a list of all of the errors that are |
4339 produced by the server and the data that is returned with each. | 4354 produced by the server and the data that is returned with each. |
4340 </p> | 4355 </p> |
4341 <p> | 4356 <p> |
4342 TBD | 4357 TBD |
4343 </p> | 4358 </p> |
4344 <h2 class="domain"><a name="index">Index</a></h2> | 4359 <h2 class="domain"><a name="index">Index</a></h2> |
4345 <index></index> | 4360 <index></index> |
4346 </body> | 4361 </body> |
4347 </html> | 4362 </html> |
OLD | NEW |