| OLD | NEW |
| 1 <html> | 1 <html> |
| 2 <head> | 2 <head> |
| 3 <meta charset="UTF-8"/> | 3 <meta charset="UTF-8"/> |
| 4 <title>Analysis Server API Specification</title> | 4 <title>Analysis Server API Specification</title> |
| 5 </head> | 5 </head> |
| 6 <body> | 6 <body> |
| 7 <h1>Analysis Server API Specification</h1> | 7 <h1>Analysis Server API Specification</h1> |
| 8 <h1 style="color:#999999">WORKING DRAFT - Version <version>0.3</version></h1
> | 8 <h1 style="color:#999999">WORKING DRAFT - Version <version>0.3</version></h1
> |
| 9 <p> | 9 <p> |
| 10 This document contains a specification of the API provided by | 10 This document contains a specification of the API provided by |
| (...skipping 256 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 267 response will contain an error to indicate why the errors | 267 response will contain an error to indicate why the errors |
| 268 could not be computed. | 268 could not be computed. |
| 269 </p> | 269 </p> |
| 270 <p> | 270 <p> |
| 271 This request is intended to be used by clients that cannot | 271 This request is intended to be used by clients that cannot |
| 272 asynchronously apply updated error information. Clients that | 272 asynchronously apply updated error information. Clients that |
| 273 <b>can</b> apply error information as it becomes available | 273 <b>can</b> apply error information as it becomes available |
| 274 should use the information provided by the 'analysis.errors' | 274 should use the information provided by the 'analysis.errors' |
| 275 notification. | 275 notification. |
| 276 </p> | 276 </p> |
| 277 <p> |
| 278 If a request is made for a file which does not exist, or |
| 279 which is not currently subject to analysis (e.g. because it |
| 280 is not associated with any analysis root specified to |
| 281 analysis.setAnalysisRoots), an error of type |
| 282 GET_ERRORS_INVALID_FILE will be generated. |
| 283 </p> |
| 277 <params> | 284 <params> |
| 278 <field name="file"> | 285 <field name="file"> |
| 279 <ref>FilePath</ref> | 286 <ref>FilePath</ref> |
| 280 <p> | 287 <p> |
| 281 The file for which errors are being requested. | 288 The file for which errors are being requested. |
| 282 </p> | 289 </p> |
| 283 </field> | 290 </field> |
| 284 </params> | 291 </params> |
| 285 <result> | 292 <result> |
| 286 <field name="errors"> | 293 <field name="errors"> |
| (...skipping 2292 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 2579 </field> | 2586 </field> |
| 2580 </object> | 2587 </object> |
| 2581 </type> | 2588 </type> |
| 2582 <type name="RequestErrorCode"> | 2589 <type name="RequestErrorCode"> |
| 2583 <p> | 2590 <p> |
| 2584 An enumeration of the types of errors that can occur in the | 2591 An enumeration of the types of errors that can occur in the |
| 2585 execution of the server. | 2592 execution of the server. |
| 2586 </p> | 2593 </p> |
| 2587 <enum> | 2594 <enum> |
| 2588 <value> | 2595 <value> |
| 2589 <code>GET_ERRORS_ERROR</code> | 2596 <code>GET_ERRORS_INVALID_FILE</code> |
| 2590 <p> | 2597 <p> |
| 2591 An error occurred during the processing of an | 2598 An "analysis.getErrors" request specified a FilePath |
| 2592 "analysis.getErrors" request. | 2599 which does not match a file currently subject to |
| 2600 analysis. |
| 2593 </p> | 2601 </p> |
| 2594 <p> | |
| 2595 This is a legacy error; it will be removed before the | |
| 2596 API reaches version 1.0. | |
| 2597 </p> | |
| 2598 <!-- TODO(paulberry): remove this error and the code that | |
| 2599 generates it. --> | |
| 2600 </value> | 2602 </value> |
| 2601 <value> | 2603 <value> |
| 2602 <code>INVALID_PARAMETER</code> | 2604 <code>INVALID_PARAMETER</code> |
| 2603 <p> | 2605 <p> |
| 2604 One of the method parameters was invalid. | 2606 One of the method parameters was invalid. |
| 2605 </p> | 2607 </p> |
| 2606 </value> | 2608 </value> |
| 2607 <value> | 2609 <value> |
| 2608 <code>INVALID_REQUEST</code> | 2610 <code>INVALID_REQUEST</code> |
| 2609 <p> | 2611 <p> |
| (...skipping 596 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 3206 <h2>Errors</h2> | 3208 <h2>Errors</h2> |
| 3207 <p> | 3209 <p> |
| 3208 This section contains a list of all of the errors that are | 3210 This section contains a list of all of the errors that are |
| 3209 produced by the server and the data that is returned with each. | 3211 produced by the server and the data that is returned with each. |
| 3210 </p> | 3212 </p> |
| 3211 <p> | 3213 <p> |
| 3212 TBD | 3214 TBD |
| 3213 </p> | 3215 </p> |
| 3214 </body> | 3216 </body> |
| 3215 </html> | 3217 </html> |
| OLD | NEW |