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.13.0</version></h1> | 9 <h1 style="color:#999999">Version <version>1.14.0</version></h1> |
10 <p> | 10 <p> |
11 This document contains a specification of the API provided by the | 11 This document contains a specification of the API provided by the |
12 analysis server. The API in this document is currently under | 12 analysis server. The API in this document is currently under |
13 development. Changes to the API will be accompanied by an update to the | 13 development. Changes to the API will be accompanied by an update to the |
14 protocol version number according to the principles of semantic | 14 protocol version number according to the principles of semantic |
15 versioning <a href="http://semver.org/">http://semver.org/</a>. | 15 versioning <a href="http://semver.org/">http://semver.org/</a>. |
16 </p> | 16 </p> |
17 <h2>Overview</h2> | 17 <h2>Overview</h2> |
18 <p> | 18 <p> |
19 The analysis server API is a bi-directional client-server | 19 The analysis server API is a bi-directional client-server |
(...skipping 1968 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1988 <field name="referencedFiles" optional="true"> | 1988 <field name="referencedFiles" optional="true"> |
1989 <list><ref>FilePath</ref></list> | 1989 <list><ref>FilePath</ref></list> |
1990 <p> | 1990 <p> |
1991 A list of the Dart files that are referenced by the file. This | 1991 A list of the Dart files that are referenced by the file. This |
1992 field is omitted if the file is not an HTML file. | 1992 field is omitted if the file is not an HTML file. |
1993 </p> | 1993 </p> |
1994 </field> | 1994 </field> |
1995 </params> | 1995 </params> |
1996 </notification> | 1996 </notification> |
1997 </domain> | 1997 </domain> |
1998 <domain name="diagnostic" experimental="true"> | 1998 <domain name="diagnostic"> |
1999 <p> | 1999 <p> |
2000 The diagnostic domain contains experimental server diagnostics APIs. Not
e | 2000 The diagnostic domain contains server diagnostics APIs. |
2001 that as an experimental API, docs are not generated for this domain and
it | |
2002 is subject subject to change without notice. | |
2003 Because this experimental domain is not part of the analysis server's AP
I, | |
2004 the version number of the API will not be updated when changes are made. | |
2005 Caveat emptor! | |
2006 </p> | 2001 </p> |
2007 <request method="getDiagnostics"> | 2002 <request method="getDiagnostics"> |
2008 <p>Return server diagnostics.</p> | 2003 <p>Return server diagnostics.</p> |
2009 <result> | 2004 <result> |
2010 <field name="contexts"> | 2005 <field name="contexts"> |
2011 <list><ref>ContextData</ref></list> | 2006 <list><ref>ContextData</ref></list> |
2012 <p>The list of analysis contexts.</p> | 2007 <p>The list of analysis contexts.</p> |
2013 </field> | 2008 </field> |
2014 </result> | 2009 </result> |
2015 </request> | 2010 </request> |
(...skipping 473 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
2489 <p> | 2484 <p> |
2490 A named argument for the current callsite is being suggested. | 2485 A named argument for the current callsite is being suggested. |
2491 For suggestions of this kind, the completion is | 2486 For suggestions of this kind, the completion is |
2492 the named argument identifier including a trailing ':' and space. | 2487 the named argument identifier including a trailing ':' and space. |
2493 </p> | 2488 </p> |
2494 </value> | 2489 </value> |
2495 <value><code>OPTIONAL_ARGUMENT</code></value> | 2490 <value><code>OPTIONAL_ARGUMENT</code></value> |
2496 <value><code>PARAMETER</code></value> | 2491 <value><code>PARAMETER</code></value> |
2497 </enum> | 2492 </enum> |
2498 </type> | 2493 </type> |
2499 <type name="ContextData" experimental="true"> | 2494 <type name="ContextData"> |
2500 <p> | 2495 <p> |
2501 Information about an analysis context. | 2496 Information about an analysis context. |
2502 </p> | 2497 </p> |
2503 <object> | 2498 <object> |
2504 <field name="name"> | 2499 <field name="name"> |
2505 <ref>String</ref> | 2500 <ref>String</ref> |
2506 <p> | 2501 <p> |
2507 The name of the context. | 2502 The name of the context. |
2508 </p> | 2503 </p> |
2509 </field> | 2504 </field> |
2510 <field name="explicitFileCount"> | 2505 <field name="explicitFileCount"> |
2511 <ref>int</ref> | 2506 <ref>int</ref> |
2512 <p> | 2507 <p> |
2513 Explicitly analyzed files. | 2508 Explicitly analyzed files. |
2514 </p> | 2509 </p> |
2515 </field> | 2510 </field> |
2516 <field name="implicitFileCount"> | 2511 <field name="implicitFileCount"> |
2517 <ref>int</ref> | 2512 <ref>int</ref> |
2518 <p> | 2513 <p> |
2519 Implicitly analyzed files. | 2514 Implicitly analyzed files. |
2520 </p> | 2515 </p> |
2521 </field> | 2516 </field> |
2522 <field name="workItemQueueLength"> | 2517 <field name="workItemQueueLength"> |
2523 <ref>int</ref> | 2518 <ref>int</ref> |
2524 <p> | 2519 <p> |
2525 The number of work items in the queue. | 2520 The number of work items in the queue. |
2526 </p> | 2521 </p> |
2527 </field> | 2522 </field> |
2528 <field name="workItemQueueLengthAverage"> | |
2529 <ref>String</ref> | |
2530 <p> | |
2531 A rolling average of work items in the queue. (A double encoded as
a String.) | |
2532 </p> | |
2533 </field> | |
2534 <field name="cacheEntryExceptions"> | 2523 <field name="cacheEntryExceptions"> |
2535 <list><ref>String</ref></list> | 2524 <list><ref>String</ref></list> |
2536 <p> | 2525 <p> |
2537 Exceptions associated with cache entries. | 2526 Exceptions associated with cache entries. |
2538 </p> | 2527 </p> |
2539 </field> | 2528 </field> |
2540 </object> | 2529 </object> |
2541 </type> | 2530 </type> |
2542 <type name="Element"> | 2531 <type name="Element"> |
2543 <p> | 2532 <p> |
(...skipping 1930 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
4474 This section contains a list of all of the errors that are | 4463 This section contains a list of all of the errors that are |
4475 produced by the server and the data that is returned with each. | 4464 produced by the server and the data that is returned with each. |
4476 </p> | 4465 </p> |
4477 <p> | 4466 <p> |
4478 TBD | 4467 TBD |
4479 </p> | 4468 </p> |
4480 <h2 class="domain"><a name="index">Index</a></h2> | 4469 <h2 class="domain"><a name="index">Index</a></h2> |
4481 <index></index> | 4470 <index></index> |
4482 </body> | 4471 </body> |
4483 </html> | 4472 </html> |
OLD | NEW |