| 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 108 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 119 <p> | 119 <p> |
| 120 The specifications of the API’s refer to data structures beyond | 120 The specifications of the API’s refer to data structures beyond |
| 121 the standard JSON primitives. These data structures are | 121 the standard JSON primitives. These data structures are |
| 122 documented in the section titled <a href="#types">Types</a>. | 122 documented in the section titled <a href="#types">Types</a>. |
| 123 </p> | 123 </p> |
| 124 <h3>Command-line Arguments</h3> | 124 <h3>Command-line Arguments</h3> |
| 125 <p> | 125 <p> |
| 126 The command-line arguments that can be passed to the server. | 126 The command-line arguments that can be passed to the server. |
| 127 </p> | 127 </p> |
| 128 <h4>Options</h4> | 128 <h4>Options</h4> |
| 129 <blockquote> |
| 129 <dl> | 130 <dl> |
| 130 <dt>--no-error-notification</dt> | 131 <dt>--no-error-notification</dt> |
| 131 <dd></dd> | 132 <dd> |
| 132 </dl> | |
| 133 <p> | |
| 134 Disable notifications about errors (see analysis.error). If this | 133 Disable notifications about errors (see analysis.error). If this |
| 135 flag is not specified then notifications will be sent for all | 134 flag is not specified then notifications will be sent for all |
| 136 errors produced for all files in the actual analysis roots. | 135 errors produced for all files in the actual analysis roots. |
| 137 </p> | 136 </dd> |
| 137 </dl> |
| 138 </blockquote> |
| 138 <domain name="server"> | 139 <domain name="server"> |
| 139 <p> | 140 <p> |
| 140 The server domain contains API’s related to the execution of | 141 The server domain contains API’s related to the execution of |
| 141 the server. | 142 the server. |
| 142 </p> | 143 </p> |
| 143 <request method="getVersion"> | 144 <request method="getVersion"> |
| 144 <p>Return the version number of the analysis server.</p> | 145 <p>Return the version number of the analysis server.</p> |
| 145 <result> | 146 <result> |
| 146 <field name="version"> | 147 <field name="version"> |
| 147 <ref>String</ref> | 148 <ref>String</ref> |
| (...skipping 1224 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 1372 <field name="subscriptions"> | 1373 <field name="subscriptions"> |
| 1373 <list><ref>ExecutionService</ref></list> | 1374 <list><ref>ExecutionService</ref></list> |
| 1374 <p> | 1375 <p> |
| 1375 A list of the services being subscribed to. | 1376 A list of the services being subscribed to. |
| 1376 </p> | 1377 </p> |
| 1377 </field> | 1378 </field> |
| 1378 </params> | 1379 </params> |
| 1379 </request> | 1380 </request> |
| 1380 <notification event="launchData"> | 1381 <notification event="launchData"> |
| 1381 <p> | 1382 <p> |
| 1382 Reports information needed to allow applications within the given | 1383 Reports information needed to allow applications to be launched. |
| 1383 context to be launched. | |
| 1384 </p> | 1384 </p> |
| 1385 <p> | 1385 <p> |
| 1386 This notification is not subscribed to by default. Clients can | 1386 This notification is not subscribed to by default. Clients can |
| 1387 subscribe by including the value "LAUNCH_DATA" in the list of services | 1387 subscribe by including the value "LAUNCH_DATA" in the list of services |
| 1388 passed in a execution.setSubscriptions request. | 1388 passed in an <tt>execution.setSubscriptions</tt> request. |
| 1389 </p> | 1389 </p> |
| 1390 <params> | 1390 <params> |
| 1391 <field name="executables"> | 1391 <field name="executables"> |
| 1392 <list><ref>ExecutableFile</ref></list> | 1392 <list><ref>ExecutableFile</ref></list> |
| 1393 <p> | 1393 <p> |
| 1394 A list of the files that are executable in the given context. This | 1394 A list of the files that are executable. This list replaces any |
| 1395 list replaces any previous list provided for the given context. | 1395 previous list provided. |
| 1396 </p> | 1396 </p> |
| 1397 </field> | 1397 </field> |
| 1398 <field name="dartToHtml"> | 1398 <field name="dartToHtml"> |
| 1399 <map> | 1399 <map> |
| 1400 <key><ref>FilePath</ref></key> | 1400 <key><ref>FilePath</ref></key> |
| 1401 <value> | 1401 <value> |
| 1402 <list><ref>FilePath</ref></list> | 1402 <list><ref>FilePath</ref></list> |
| 1403 </value> | 1403 </value> |
| 1404 </map> | 1404 </map> |
| 1405 <p> | 1405 <p> |
| (...skipping 10 matching lines...) Expand all Loading... |
| 1416 </map> | 1416 </map> |
| 1417 <p> | 1417 <p> |
| 1418 A mapping from the paths of HTML files that reference Dart files | 1418 A mapping from the paths of HTML files that reference Dart files |
| 1419 to a list of the Dart files they reference. | 1419 to a list of the Dart files they reference. |
| 1420 </p> | 1420 </p> |
| 1421 </field> | 1421 </field> |
| 1422 </params> | 1422 </params> |
| 1423 </notification> | 1423 </notification> |
| 1424 </domain> | 1424 </domain> |
| 1425 <types> | 1425 <types> |
| 1426 <h2><a name="types">Types</a></h2> | 1426 <h2 class="domain"><a name="types">Types</a></h2> |
| 1427 <p> | 1427 <p> |
| 1428 This section contains descriptions of the data types referenced | 1428 This section contains descriptions of the data types referenced |
| 1429 in the API’s of the various domains. | 1429 in the API’s of the various domains. |
| 1430 </p> | 1430 </p> |
| 1431 <type name="AddContentOverlay"> | 1431 <type name="AddContentOverlay"> |
| 1432 <p> | 1432 <p> |
| 1433 A directive to begin overlaying the contents of a file. The | 1433 A directive to begin overlaying the contents of a file. The |
| 1434 supplied content will be used for analysis in place of the | 1434 supplied content will be used for analysis in place of the |
| 1435 file contents in the filesystem. | 1435 file contents in the filesystem. |
| 1436 </p> | 1436 </p> |
| (...skipping 1802 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 3239 <h2>Errors</h2> | 3239 <h2>Errors</h2> |
| 3240 <p> | 3240 <p> |
| 3241 This section contains a list of all of the errors that are | 3241 This section contains a list of all of the errors that are |
| 3242 produced by the server and the data that is returned with each. | 3242 produced by the server and the data that is returned with each. |
| 3243 </p> | 3243 </p> |
| 3244 <p> | 3244 <p> |
| 3245 TBD | 3245 TBD |
| 3246 </p> | 3246 </p> |
| 3247 </body> | 3247 </body> |
| 3248 </html> | 3248 </html> |
| OLD | NEW |