| 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 350 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 361 response will contain an error to indicate why the errors | 361 response will contain an error to indicate why the errors |
| 362 could not be computed. | 362 could not be computed. |
| 363 </p> | 363 </p> |
| 364 <p> | 364 <p> |
| 365 This request is intended to be used by clients that cannot | 365 This request is intended to be used by clients that cannot |
| 366 asynchronously apply updated error information. Clients that | 366 asynchronously apply updated error information. Clients that |
| 367 <b>can</b> apply error information as it becomes available | 367 <b>can</b> apply error information as it becomes available |
| 368 should use the information provided by the 'analysis.errors' | 368 should use the information provided by the 'analysis.errors' |
| 369 notification. | 369 notification. |
| 370 </p> | 370 </p> |
| 371 <p> |
| 372 If a request is made for a file which does not exist, or |
| 373 which is not currently subject to analysis (e.g. because it |
| 374 is not associated with any analysis root specified to |
| 375 analysis.setAnalysisRoots), an error of type |
| 376 GET_ERRORS_INVALID_FILE will be generated. |
| 377 </p> |
| 371 | 378 |
| 372 | 379 |
| 373 <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FileP
ath">FilePath</a> )</i></b></dt><dd> | 380 <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FileP
ath">FilePath</a> )</i></b></dt><dd> |
| 374 | 381 |
| 375 <p> | 382 <p> |
| 376 The file for which errors are being requested. | 383 The file for which errors are being requested. |
| 377 </p> | 384 </p> |
| 378 </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>errors ( List<
;<a href="#type_AnalysisError">AnalysisError</a>> )</i></b></dt><dd> | 385 </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>errors ( List<
;<a href="#type_AnalysisError">AnalysisError</a>> )</i></b></dt><dd> |
| 379 | 386 |
| 380 <p> | 387 <p> |
| (...skipping 2190 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 2571 <p> | 2578 <p> |
| 2572 Additional data related to the error. This field is | 2579 Additional data related to the error. This field is |
| 2573 omitted if there is no additional data available. | 2580 omitted if there is no additional data available. |
| 2574 </p> | 2581 </p> |
| 2575 </dd></dl></dd><dt class="typeDefinition"><a name="type_RequestErrorCo
de">RequestErrorCode: String</a></dt><dd> | 2582 </dd></dl></dd><dt class="typeDefinition"><a name="type_RequestErrorCo
de">RequestErrorCode: String</a></dt><dd> |
| 2576 <p> | 2583 <p> |
| 2577 An enumeration of the types of errors that can occur in the | 2584 An enumeration of the types of errors that can occur in the |
| 2578 execution of the server. | 2585 execution of the server. |
| 2579 </p> | 2586 </p> |
| 2580 | 2587 |
| 2581 <dl><dt class="value">GET_ERRORS_ERROR</dt><dd> | 2588 <dl><dt class="value">GET_ERRORS_INVALID_FILE</dt><dd> |
| 2582 | 2589 |
| 2583 <p> | 2590 <p> |
| 2584 An error occurred during the processing of an | 2591 An "analysis.getErrors" request specified a FilePath |
| 2585 "analysis.getErrors" request. | 2592 which does not match a file currently subject to |
| 2593 analysis. |
| 2586 </p> | 2594 </p> |
| 2587 <p> | |
| 2588 This is a legacy error; it will be removed before the | |
| 2589 API reaches version 1.0. | |
| 2590 </p> | |
| 2591 | |
| 2592 </dd><dt class="value">INVALID_PARAMETER</dt><dd> | 2595 </dd><dt class="value">INVALID_PARAMETER</dt><dd> |
| 2593 | 2596 |
| 2594 <p> | 2597 <p> |
| 2595 One of the method parameters was invalid. | 2598 One of the method parameters was invalid. |
| 2596 </p> | 2599 </p> |
| 2597 </dd><dt class="value">INVALID_REQUEST</dt><dd> | 2600 </dd><dt class="value">INVALID_REQUEST</dt><dd> |
| 2598 | 2601 |
| 2599 <p> | 2602 <p> |
| 2600 A malformed request was received. | 2603 A malformed request was received. |
| 2601 </p> | 2604 </p> |
| (...skipping 512 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 3114 <p> | 3117 <p> |
| 3115 This section contains a list of all of the errors that are | 3118 This section contains a list of all of the errors that are |
| 3116 produced by the server and the data that is returned with each. | 3119 produced by the server and the data that is returned with each. |
| 3117 </p> | 3120 </p> |
| 3118 <p> | 3121 <p> |
| 3119 TBD | 3122 TBD |
| 3120 </p> | 3123 </p> |
| 3121 | 3124 |
| 3122 | 3125 |
| 3123 </body></html> | 3126 </body></html> |
| OLD | NEW |