pkg/analysis_server/tool/spec/spec_input.html - Issue 1416093007: Experimental `getDiagnostics` request (#24480).

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

Issue 1416093007: Experimental `getDiagnostics` request (#24480). (Closed) Base URL: git@github.com:dart-lang/sdk.git@master

Patch Set: Created 5 years, 1 month 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

« pkg/analysis_server/tool/spec/from_html.dart ('K') | « pkg/analysis_server/tool/spec/generated/java/types/ContextInfo.java ('k') | pkg/analysis_server/tool/spec/to_html.dart » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Hide Comments ('s')

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.12.0</version></h1>	9 <h1 style="color:#999999">Version <version>1.12.0</version></h1>

10 <p>	10 <p>

(...skipping 1941 matching lines...) Expand 10 before \| Expand all \| Expand 10 after Loading...
1952 <field name="referencedFiles" optional="true">	1952 <field name="referencedFiles" optional="true">

1953 <list><ref>FilePath</ref></list>	1953 <list><ref>FilePath</ref></list>

1954 <p>	1954 <p>

1955 A list of the Dart files that are referenced by the file. This	1955 A list of the Dart files that are referenced by the file. This

1956 field is omitted if the file is not an HTML file.	1956 field is omitted if the file is not an HTML file.

1957 </p>	1957 </p>

1958 </field>	1958 </field>

1959 </params>	1959 </params>

1960 </notification>	1960 </notification>

1961 </domain>	1961 </domain>

	1962 <domain name="experimental" experimental="true">

	1963 <p>

	1964 The experimental domain contains experimental server APIs. Experimental

	1965 APIs are not considered to be part of the analysis server's API, docs ar e

	1966 not generated for them and they are subject to change without notice.

	1967 Because the experimental domain is not part of the analysis server's API ,

	1968 the version number of the API will not be updated when changes are made.

	1969 Caveat emptor!

	1970 </p>

	1971 <request method="getDiagnostics">

	1972 <p>Return server diagnostics.</p>

	1973 <result>

	1974 <field name="contexts">

	1975 <list><ref>ContextInfo</ref></list>

	1976 <p>The list of analysis contexts.</p>

	1977 </field>

	1978 </result>

	1979 </request>

	1980 </domain>

1962 <types>	1981 <types>

1963 <h2 class="domain"><a name="types">Types</a></h2>	1982 <h2 class="domain"><a name="types">Types</a></h2>

1964 <p>	1983 <p>

1965 This section contains descriptions of the data types referenced	1984 This section contains descriptions of the data types referenced

1966 in the API’s of the various domains.	1985 in the API’s of the various domains.

1967 </p>	1986 </p>

1968 <type name="AddContentOverlay">	1987 <type name="AddContentOverlay">

1969 <p>	1988 <p>

1970 A directive to begin overlaying the contents of a file. The	1989 A directive to begin overlaying the contents of a file. The

1971 supplied content will be used for analysis in place of the	1990 supplied content will be used for analysis in place of the

(...skipping 462 matching lines...) Expand 10 before \| Expand all \| Expand 10 after Loading...
2434 <p>	2453 <p>

2435 A named argument for the current callsite is being suggested.	2454 A named argument for the current callsite is being suggested.

2436 For suggestions of this kind, the completion is	2455 For suggestions of this kind, the completion is

2437 the named argument identifier including a trailing ':' and space.	2456 the named argument identifier including a trailing ':' and space.

2438 </p>	2457 </p>

2439 </value>	2458 </value>

2440 <value><code>OPTIONAL_ARGUMENT</code></value>	2459 <value><code>OPTIONAL_ARGUMENT</code></value>

2441 <value><code>PARAMETER</code></value>	2460 <value><code>PARAMETER</code></value>

2442 </enum>	2461 </enum>

2443 </type>	2462 </type>

	2463 <type name="ContextInfo" experimental="true">

	2464 <p>

	2465 Information about an analysis context.

	2466 </p>

	2467 <object>

	2468 <field name="name">

	2469 <ref>String</ref>

	2470 <p>

	2471 The name of the context.

	2472 </p>

	2473 </field>

	2474 <field name="explicitlyAnalyzedFiles">

	2475 <ref>int</ref>

	2476 <p>

	2477 Explicitly analyzed files.

	2478 </p>

	2479 </field>

	2480 <field name="implicitlyAnalyzedFiles">

	2481 <ref>int</ref>

	2482 <p>

	2483 Implicitly analyzed files.

	2484 </p>

	2485 </field>

	2486 <field name="workItemQueueLength">

	2487 <ref>int</ref>

	2488 <p>

	2489 The number of work items in the queue.
	scheglov 2015/11/05 21:22:22 It seems to me that it's not very useful metrics. It seems to me that it's not very useful metrics. It's just a number of steps for the current work order. And it will be changing quickly, but reaching zero does not mean much. There might be unknown number of work orders to be scheduled later. pquitslund 2015/11/05 22:28:54 Yeah. I'm not sure. The idea was that maybe if o Show quoted text On 2015/11/05 21:22:22, scheglov wrote: > It seems to me that it's not very useful metrics. > It's just a number of steps for the current work order. > And it will be changing quickly, but reaching zero does not mean much. > There might be unknown number of work orders to be scheduled later. Yeah. I'm not sure. The idea was that maybe if over time we see that there are always items queued maybe that would indicate something? Definitely something to experiment with. Very open to other ideas!
	2490 </p>

	2491 </field>

	2492 <field name="cacheEntryExceptions">

	2493 <list><ref>String</ref></list>

	2494 <p>

	2495 Exceptions associated with cache entries.
	scheglov 2015/11/05 21:22:22 If any of these exceptions are going to be used to If any of these exceptions are going to be used to open issues against analyzer, I'd like to know the entry target. pquitslund 2015/11/05 22:28:54 At this point that's not the intention though it m Show quoted text On 2015/11/05 21:22:22, scheglov wrote: > If any of these exceptions are going to be used to open issues against analyzer, > I'd like to know the entry target. At this point that's not the intention though it may down the road. In short order this is just to give us an indication of health. If it turns out that Devon wants to do something interesting with these exceptions, you're right that we should add at least the target for sure.
	2496 </p>

	2497 </field>

	2498 </object>

	2499 </type>

2444 <type name="Element">	2500 <type name="Element">

2445 <p>	2501 <p>

2446 Information about an element (something that can be declared	2502 Information about an element (something that can be declared

2447 in code).	2503 in code).

2448 </p>	2504 </p>

2449 <object>	2505 <object>

2450 <field name="kind">	2506 <field name="kind">

2451 <ref>ElementKind</ref>	2507 <ref>ElementKind</ref>

2452 <p>	2508 <p>

2453 The kind of the element.	2509 The kind of the element.

(...skipping 1914 matching lines...) Expand 10 before \| Expand all \| Expand 10 after Loading...
4368 This section contains a list of all of the errors that are	4424 This section contains a list of all of the errors that are

4369 produced by the server and the data that is returned with each.	4425 produced by the server and the data that is returned with each.

4370 </p>	4426 </p>

4371 <p>	4427 <p>

4372 TBD	4428 TBD

4373 </p>	4429 </p>

4374 <h2 class="domain"><a name="index">Index</a></h2>	4430 <h2 class="domain"><a name="index">Index</a></h2>

4375 <index></index>	4431 <index></index>

4376 </body>	4432 </body>

4377 </html>	4433 </html>

OLD	NEW