| 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 2573 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 2584 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 |
| 2585 execution of the server. | 2585 execution of the server. |
| 2586 </p> | 2586 </p> |
| 2587 <enum> | 2587 <enum> |
| 2588 <value> | 2588 <value> |
| 2589 <code>GET_ERRORS_ERROR</code> | 2589 <code>GET_ERRORS_ERROR</code> |
| 2590 <p> | 2590 <p> |
| 2591 An error occurred during the processing of an | 2591 An error occurred during the processing of an |
| 2592 "analysis.getErrors" request. | 2592 "analysis.getErrors" request. |
| 2593 </p> | 2593 </p> |
| 2594 <!-- TODO(paulberry): this is vague. We should be more | 2594 <p> |
| 2595 specific about the nature of the error if we can. --> | 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. --> |
| 2596 </value> | 2600 </value> |
| 2597 <value> | 2601 <value> |
| 2598 <code>INVALID_PARAMETER</code> | 2602 <code>INVALID_PARAMETER</code> |
| 2599 <p> | 2603 <p> |
| 2600 One of the method parameters was invalid. | 2604 One of the method parameters was invalid. |
| 2601 </p> | 2605 </p> |
| 2602 </value> | 2606 </value> |
| 2603 <value> | 2607 <value> |
| 2604 <code>INVALID_REQUEST</code> | 2608 <code>INVALID_REQUEST</code> |
| 2605 <p> | 2609 <p> |
| 2606 A malformed request was received. | 2610 A malformed request was received. |
| 2607 </p> | 2611 </p> |
| 2608 </value> | 2612 </value> |
| 2609 <value> | 2613 <value> |
| 2610 <code>SERVER_ALREADY_STARTED</code> | 2614 <code>SERVER_ALREADY_STARTED</code> |
| 2611 <!-- TODO(paulberry): this error code doesn't make sense | |
| 2612 anymore. --> | |
| 2613 <p> | 2615 <p> |
| 2614 The analysis server has already been started (and hence | 2616 The analysis server has already been started (and hence |
| 2615 won't accept new connections). | 2617 won't accept new connections). |
| 2616 </p> | 2618 </p> |
| 2619 <p> |
| 2620 This error is included for future expansion; at present |
| 2621 the analysis server can only speak to one client at a |
| 2622 time so this error will never occur. |
| 2623 </p> |
| 2617 </value> | 2624 </value> |
| 2618 <value> | 2625 <value> |
| 2619 <code>UNANALYZED_PRIORITY_FILES</code> | 2626 <code>UNANALYZED_PRIORITY_FILES</code> |
| 2620 <!-- TODO(paulberry): this error shouldn't be issued under | |
| 2621 our new "eventual consistency" model. --> | |
| 2622 <p> | 2627 <p> |
| 2623 An "analysis.setPriorityFiles" request includes one or | 2628 An "analysis.setPriorityFiles" request includes one or |
| 2624 more files that are not being analyzed. | 2629 more files that are not being analyzed. |
| 2625 </p> | 2630 </p> |
| 2631 <p> |
| 2632 This is a legacy error; it will be removed before the |
| 2633 API reaches version 1.0. |
| 2634 </p> |
| 2635 <!-- TODO(paulberry): remove this error and the code that |
| 2636 generates it. --> |
| 2626 </value> | 2637 </value> |
| 2627 <value> | 2638 <value> |
| 2628 <code>UNKNOWN_REQUEST</code> | 2639 <code>UNKNOWN_REQUEST</code> |
| 2629 <p> | 2640 <p> |
| 2630 A request was received which the analysis server does | 2641 A request was received which the analysis server does |
| 2631 not recognize, or cannot handle in its current | 2642 not recognize, or cannot handle in its current |
| 2632 configuation. | 2643 configuation. |
| 2633 </p> | 2644 </p> |
| 2634 </value> | 2645 </value> |
| 2635 <value> | 2646 <value> |
| 2636 <code>UNSUPPORTED_FEATURE</code> | 2647 <code>UNSUPPORTED_FEATURE</code> |
| 2637 <p> | 2648 <p> |
| 2638 The analysis server was requested to perform an action | 2649 The analysis server was requested to perform an action |
| 2639 which is not supported. | 2650 which is not supported. |
| 2640 </p> | 2651 </p> |
| 2641 <!-- TODO(paulberry): how does this differ from | 2652 <p> |
| 2642 UNKNOWN_REQUEST? Do we really need both? --> | 2653 This is a legacy error; it will be removed before the |
| 2654 API reaches version 1.0. |
| 2655 </p> |
| 2656 <!-- TODO(paulberry): remove this error and the code that |
| 2657 generates it. --> |
| 2643 </value> | 2658 </value> |
| 2644 </enum> | 2659 </enum> |
| 2645 </type> | 2660 </type> |
| 2646 <type name="SearchId"> | 2661 <type name="SearchId"> |
| 2647 <ref>String</ref> | 2662 <ref>String</ref> |
| 2648 <p> | 2663 <p> |
| 2649 An identifier used to associate search results with a search | 2664 An identifier used to associate search results with a search |
| 2650 request. | 2665 request. |
| 2651 </p> | 2666 </p> |
| 2652 </type> | 2667 </type> |
| (...skipping 538 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 3191 <h2>Errors</h2> | 3206 <h2>Errors</h2> |
| 3192 <p> | 3207 <p> |
| 3193 This section contains a list of all of the errors that are | 3208 This section contains a list of all of the errors that are |
| 3194 produced by the server and the data that is returned with each. | 3209 produced by the server and the data that is returned with each. |
| 3195 </p> | 3210 </p> |
| 3196 <p> | 3211 <p> |
| 3197 TBD | 3212 TBD |
| 3198 </p> | 3213 </p> |
| 3199 </body> | 3214 </body> |
| 3200 </html> | 3215 </html> |
| OLD | NEW |