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.16.0</version></h1> | 9 <h1 style="color:#999999">Version <version>1.16.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/">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 |
20 API. The API is independent of the transport mechanism used, but | 20 API. The API is independent of the transport mechanism used, but |
21 is heavily influenced by a model in which sockets or character | 21 is heavily influenced by a model in which sockets or character |
22 streams are used to transport JSON-RPC encoded information. | 22 streams are used to transport JSON-RPC encoded information. |
23 </p> | 23 </p> |
24 <h3>Transport Mechanism</h3> | 24 <h3>Transport Mechanism</h3> |
25 <p> | 25 <p> |
(...skipping 85 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
111 described with each notification. | 111 described with each notification. |
112 </p> | 112 </p> |
113 <p> | 113 <p> |
114 In order to be backward compatible, clients should ignore fields that were | 114 In order to be backward compatible, clients should ignore fields that were |
115 not specified in the version of the API on which they were based. Clients | 115 not specified in the version of the API on which they were based. Clients |
116 should also use the server.getVersion request to test that the version of | 116 should also use the server.getVersion request to test that the version of |
117 the server supports an API before using it. | 117 the server supports an API before using it. |
118 </p> | 118 </p> |
119 <h3>Eventual Consistency</h3> | 119 <h3>Eventual Consistency</h3> |
120 <p> | 120 <p> |
121 TBD | 121 TODO: TBD |
122 </p> | 122 </p> |
123 <h3>Domains</h3> | 123 <h3>Domains</h3> |
124 <p> | 124 <p> |
125 For convenience, the API is divided into domains. Each domain is | 125 For convenience, the API is divided into domains. Each domain is |
126 specified in a separate section below: | 126 specified in a separate section below: |
127 </p> | 127 </p> |
128 <ul> | 128 <ul> |
129 <li><a href="#domain_server">Server</a></li> | 129 <li><a href="#domain_server">Server</a></li> |
130 <li><a href="#domain_analysis">Analysis</a></li> | 130 <li><a href="#domain_analysis">Analysis</a></li> |
131 <li><a href="#domain_completion">Code Completion</a></li> | 131 <li><a href="#domain_completion">Code Completion</a></li> |
(...skipping 4364 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
4496 </field> | 4496 </field> |
4497 </options> | 4497 </options> |
4498 </refactoring> | 4498 </refactoring> |
4499 </refactorings> | 4499 </refactorings> |
4500 <h2>Errors</h2> | 4500 <h2>Errors</h2> |
4501 <p> | 4501 <p> |
4502 This section contains a list of all of the errors that are | 4502 This section contains a list of all of the errors that are |
4503 produced by the server and the data that is returned with each. | 4503 produced by the server and the data that is returned with each. |
4504 </p> | 4504 </p> |
4505 <p> | 4505 <p> |
4506 TBD | 4506 TODO: TBD |
4507 </p> | 4507 </p> |
4508 <h2 class="domain"><a name="index">Index</a></h2> | 4508 <h2 class="domain"><a name="index">Index</a></h2> |
4509 <index></index> | 4509 <index></index> |
4510 </body> | 4510 </body> |
4511 </html> | 4511 </html> |
OLD | NEW |