Chromium Code Reviews Chromium Code Reviews
Issue 2703033002:
Add a diagnostic.getServerPort analysis server request. (Closed)
| 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.17.0</version></h1> | 9 <h1 style="color:#999999">Version <version>1.18.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/">semver.org</a>). | 15 versioning (<a href="http://semver.org/">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 2022 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... | |
| 2042 </p> | 2042 </p> |
| 2043 <request method="getDiagnostics"> | 2043 <request method="getDiagnostics"> |
| 2044 <p>Return server diagnostics.</p> | 2044 <p>Return server diagnostics.</p> |
| 2045 <result> | 2045 <result> |
| 2046 <field name="contexts"> | 2046 <field name="contexts"> |
| 2047 <list><ref>ContextData</ref></list> | 2047 <list><ref>ContextData</ref></list> |
| 2048 <p>The list of analysis contexts.</p> | 2048 <p>The list of analysis contexts.</p> |
| 2049 </field> | 2049 </field> |
| 2050 </result> | 2050 </result> |
| 2051 </request> | 2051 </request> |
| 2052 <request method="getServerPort"> | |
| 2053 <p> | |
| 2054 Return the port of the diagnostic web server. If the server is not run ning | |
| 2055 this call will start the server. If unable to start the diagnostic web server, | |
| 2056 this call will return an error of DEBUG_PORT_COULD_NOT_BE_OPENED. | |
|
Brian Wilkerson
2017/02/19 16:47:18
nit: everywhere else we've surrounded the name of
devoncarew
2017/02/19 23:17:39
Done.
| |
| 2057 </p> | |
| 2058 <result> | |
| 2059 <field name="port"> | |
| 2060 <ref>int</ref> | |
| 2061 <p>The diagnostic server port.</p> | |
| 2062 </field> | |
| 2063 </result> | |
| 2064 </request> | |
| 2052 </domain> | 2065 </domain> |
| 2053 <types> | 2066 <types> |
| 2054 <h2 class="domain"><a name="types">Types</a></h2> | 2067 <h2 class="domain"><a name="types">Types</a></h2> |
| 2055 <p> | 2068 <p> |
| 2056 This section contains descriptions of the data types referenced | 2069 This section contains descriptions of the data types referenced |
| 2057 in the API’s of the various domains. | 2070 in the API’s of the various domains. |
| 2058 </p> | 2071 </p> |
| 2059 <type name="AddContentOverlay"> | 2072 <type name="AddContentOverlay"> |
| 2060 <p> | 2073 <p> |
| 2061 A directive to begin overlaying the contents of a file. The | 2074 A directive to begin overlaying the contents of a file. The |
| (...skipping 1662 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... | |
| 3724 <enum> | 3737 <enum> |
| 3725 <value> | 3738 <value> |
| 3726 <code>CONTENT_MODIFIED</code> | 3739 <code>CONTENT_MODIFIED</code> |
| 3727 <p> | 3740 <p> |
| 3728 An "analysis.getErrors" or "analysis.getNavigation" request could | 3741 An "analysis.getErrors" or "analysis.getNavigation" request could |
| 3729 not be satisfied because the content of the file changed before | 3742 not be satisfied because the content of the file changed before |
| 3730 the requested results could be computed. | 3743 the requested results could be computed. |
| 3731 </p> | 3744 </p> |
| 3732 </value> | 3745 </value> |
| 3733 <value> | 3746 <value> |
| 3747 <code>DEBUG_PORT_COULD_NOT_BE_OPENED</code> | |
| 3748 <p> | |
| 3749 The server was unable to a port for the diagnostic server. | |
|
Brian Wilkerson
2017/02/19 16:47:18
"to a" --> "to open a"
devoncarew
2017/02/19 23:17:39
Done.
| |
| 3750 </p> | |
| 3751 </value> | |
| 3752 <value> | |
| 3734 <code>FILE_NOT_ANALYZED</code> | 3753 <code>FILE_NOT_ANALYZED</code> |
| 3735 <p> | 3754 <p> |
| 3736 A request specified a FilePath which does not match a file in | 3755 A request specified a FilePath which does not match a file in |
| 3737 an analysis root, or the requested operation is not available | 3756 an analysis root, or the requested operation is not available |
| 3738 for the file. | 3757 for the file. |
| 3739 </p> | 3758 </p> |
| 3740 </value> | 3759 </value> |
| 3741 <value> | 3760 <value> |
| 3742 <code>FORMAT_INVALID_FILE</code> | 3761 <code>FORMAT_INVALID_FILE</code> |
| 3743 <p> | 3762 <p> |
| (...skipping 820 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... | |
| 4564 This section contains a list of all of the errors that are | 4583 This section contains a list of all of the errors that are |
| 4565 produced by the server and the data that is returned with each. | 4584 produced by the server and the data that is returned with each. |
| 4566 </p> | 4585 </p> |
| 4567 <p> | 4586 <p> |
| 4568 TODO: TBD | 4587 TODO: TBD |
| 4569 </p> | 4588 </p> |
| 4570 <h2 class="domain"><a name="index">Index</a></h2> | 4589 <h2 class="domain"><a name="index">Index</a></h2> |
| 4571 <index></index> | 4590 <index></index> |
| 4572 </body> | 4591 </body> |
| 4573 </html> | 4592 </html> |
| OLD | NEW |
