pkg/analysis_server/tool/spec/spec_input.html - Issue 513853002: In the analysis server API, change RequestError.code to an enum.

Side by Side Diff: pkg/analysis_server/tool/spec/spec_input.html

Issue 513853002: In the analysis server API, change RequestError.code to an enum. (Closed) Base URL: https://dart.googlecode.com/svn/branches/bleeding_edge/dart

Patch Set: Created 6 years, 3 months ago

Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.

Jump to:

View unified diff | Download patch | Annotate | Revision Log

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 1861 matching lines...) Expand 10 before \| Expand all \| Expand 10 after Loading...
1872 <value><code>TOP_LEVEL_VARIABLE</code></value>	1872 <value><code>TOP_LEVEL_VARIABLE</code></value>

1873 <value><code>TYPE_PARAMETER</code></value>	1873 <value><code>TYPE_PARAMETER</code></value>

1874 <value><code>UNIT_TEST_GROUP</code></value>	1874 <value><code>UNIT_TEST_GROUP</code></value>

1875 <value><code>UNIT_TEST_TEST</code></value>	1875 <value><code>UNIT_TEST_TEST</code></value>

1876 <value><code>UNKNOWN</code></value>	1876 <value><code>UNKNOWN</code></value>

1877 </enum>	1877 </enum>

1878 </type>	1878 </type>

1879 <type name="Error">	1879 <type name="Error">

1880 <p>	1880 <p>

1881 An indication of a problem with the execution of the server,	1881 An indication of a problem with the execution of the server,

1882 typically in response to a request. The error codes that can	1882 typically in response to a request.

1883 be returned are documented in the section titled Errors.

1884 </p>	1883 </p>

1885 <object>	1884 <object>

1886 <field name="code">	1885 <field name="code">

1887 <ref>String</ref>	1886 <ref>RequestErrorCode</ref>

1888 <p>	1887 <p>

1889 A code that uniquely identifies the error that occurred.	1888 A code that uniquely identifies the error that occurred.

1890 </p>	1889 </p>

1891 </field>	1890 </field>

1892 <field name="message">	1891 <field name="message">

1893 <ref>String</ref>	1892 <ref>String</ref>

1894 <p>	1893 <p>

1895 A short description of the error.	1894 A short description of the error.

1896 </p>	1895 </p>

1897 </field>	1896 </field>

(...skipping 667 matching lines...) Expand 10 before \| Expand all \| Expand 10 after Loading...
2565 again be read from the file system.	2564 again be read from the file system.

2566 </p>	2565 </p>

2567 <p>	2566 <p>

2568 If this directive is used on a file that doesn't currently	2567 If this directive is used on a file that doesn't currently

2569 have a content overlay, it has no effect.	2568 have a content overlay, it has no effect.

2570 </p>	2569 </p>

2571 <object>	2570 <object>

2572 <field name="type" value="remove"><ref>String</ref></field>	2571 <field name="type" value="remove"><ref>String</ref></field>

2573 </object>	2572 </object>

2574 </type>	2573 </type>

	2574 <type name="RequestErrorCode">

	2575 <p>

	2576 An enumeration of the types of errors that can occur in the

	2577 execution of the server.

	2578 </p>

	2579 <enum>

	2580 <value>

	2581 <code>GET_ERRORS_ERROR</code>
	Brian Wilkerson 2014/08/27 21:05:22 This seems rather vague. Any chance we can be more This seems rather vague. Any chance we can be more specific about the nature of the error? If not, then perhaps something more general to make it clear that we can't be specific, such as REQUEST_ERROR. Paul Berry 2014/08/29 07:30:21 Agreed. I've added a TODO comment. Show quoted text On 2014/08/27 21:05:22, Brian Wilkerson wrote: > This seems rather vague. Any chance we can be more specific about the nature of > the error? If not, then perhaps something more general to make it clear that we > can't be specific, such as REQUEST_ERROR. Agreed. I've added a TODO comment.
	2582 <p>

	2583 An error occurred during the processing of an

	2584 "analysis.getErrors" request.

	2585 </p>

	2586 </value>

	2587 <value>

	2588 <code>INVALID_PARAMETER</code>

	2589 <p>

	2590 One of the method parameters was invalid.

	2591 </p>

	2592 </value>

	2593 <value>

	2594 <code>INVALID_REQUEST</code>

	2595 <p>

	2596 A malformed request was received.

	2597 </p>

	2598 </value>

	2599 <value>

	2600 <code>SERVER_ALREADY_STARTED</code>
	Brian Wilkerson 2014/08/27 21:05:21 Are you planning on removing this and the followin Are you planning on removing this and the following value in a later CL? Paul Berry 2014/08/29 07:30:21 Yes. Show quoted text On 2014/08/27 21:05:21, Brian Wilkerson wrote: > Are you planning on removing this and the following value in a later CL? Yes.
	2601 <!-- TODO(paulberry): this error code doesn't make sense

	2602 anymore. -->

	2603 <p>

	2604 The analysis server has already been started (and hence

	2605 won't accept new connections).

	2606 </p>

	2607 </value>

	2608 <value>

	2609 <code>UNANALYZED_PRIORITY_FILES</code>

	2610 <!-- TODO(paulberry): this error shouldn't be issued under

	2611 our new "eventual consistency" model. -->

	2612 <p>

	2613 An "analysis.setPriorityFiles" request includes one or

	2614 more files that are not being analyzed.

	2615 </p>

	2616 </value>

	2617 <value>

	2618 <code>UNKNOWN_REQUEST</code>

	2619 <p>

	2620 A request was received which the analysis server does

	2621 not recognize, or cannot handle in its current

	2622 configuation.

	2623 </p>

	2624 </value>

	2625 <value>

	2626 <code>UNSUPPORTED_FEATURE</code>
	Brian Wilkerson 2014/08/27 21:05:21 Not clear to me how this differs from UNKNOWN_REQU Not clear to me how this differs from UNKNOWN_REQUEST, probably because I don't know what "feature" means in this context. Paul Berry 2014/08/29 07:30:21 I don't know either. I've added a TODO comment to Show quoted text On 2014/08/27 21:05:21, Brian Wilkerson wrote: > Not clear to me how this differs from UNKNOWN_REQUEST, probably because I don't > know what "feature" means in this context. I don't know either. I've added a TODO comment to remind us to clean this up.
	2627 <p>

	2628 The analysis server was requested to perform an action

	2629 which is not supported.

	2630 </p>

	2631 </value>

	2632 </enum>

	2633 </type>

2575 <type name="SearchId">	2634 <type name="SearchId">

2576 <ref>String</ref>	2635 <ref>String</ref>

2577 <p>	2636 <p>

2578 An identifier used to associate search results with a search	2637 An identifier used to associate search results with a search

2579 request.	2638 request.

2580 </p>	2639 </p>

2581 </type>	2640 </type>

2582 <type name="SearchResult">	2641 <type name="SearchResult">

2583 <p>	2642 <p>

2584 A single result from a search request.	2643 A single result from a search request.

(...skipping 543 matching lines...) Expand 10 before \| Expand all \| Expand 10 after Loading...
3128 <h2>Errors</h2>	3187 <h2>Errors</h2>

3129 <p>	3188 <p>

3130 This section contains a list of all of the errors that are	3189 This section contains a list of all of the errors that are

3131 produced by the server and the data that is returned with each.	3190 produced by the server and the data that is returned with each.

3132 </p>	3191 </p>

3133 <p>	3192 <p>

3134 TBD	3193 TBD

3135 </p>	3194 </p>

3136 </body>	3195 </body>

3137 </html>	3196 </html>

OLD	NEW

« no previous file with comments | « pkg/analysis_server/test/socket_server_test.dart ('k') | no next file » | no next file with comments »