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">Version <version>1.6.0</version></h1> | 8 <h1 style="color:#999999">Version <version>1.6.1</version></h1> |
9 <p> | 9 <p> |
10 This document contains a specification of the API provided by the | 10 This document contains a specification of the API provided by the |
11 analysis server. The API in this document is currently under | 11 analysis server. The API in this document is currently under |
12 development. Changes to the API will be accompanied by an update to the | 12 development. Changes to the API will be accompanied by an update to the |
13 protocol version number according to the principles of semantic | 13 protocol version number according to the principles of semantic |
14 versioning <a href="http://semver.org/">http://semver.org/</a>. | 14 versioning <a href="http://semver.org/">http://semver.org/</a>. |
15 </p> | 15 </p> |
16 <h2>Overview</h2> | 16 <h2>Overview</h2> |
17 <p> | 17 <p> |
18 The analysis server API is a bi-directional client-server | 18 The analysis server API is a bi-directional client-server |
(...skipping 2174 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
2193 an optional argument within an argument list. | 2193 an optional argument within an argument list. |
2194 </p> | 2194 </p> |
2195 </field> | 2195 </field> |
2196 <field name="parameterType" optional="true"> | 2196 <field name="parameterType" optional="true"> |
2197 <ref>String</ref> | 2197 <ref>String</ref> |
2198 <p> | 2198 <p> |
2199 The type of the options parameter being suggested. This | 2199 The type of the options parameter being suggested. This |
2200 field is omitted if the parameterName field is omitted. | 2200 field is omitted if the parameterName field is omitted. |
2201 </p> | 2201 </p> |
2202 </field> | 2202 </field> |
| 2203 <field name="importUri" optional="true"> |
| 2204 <ref>String</ref> |
| 2205 <p> |
| 2206 The import to be added if the suggestion is out of scope |
| 2207 and needs an import to be added to be in scope. |
| 2208 </p> |
| 2209 </field> |
2203 </object> | 2210 </object> |
2204 </type> | 2211 </type> |
2205 <type name="CompletionSuggestionKind"> | 2212 <type name="CompletionSuggestionKind"> |
2206 <p> | 2213 <p> |
2207 An enumeration of the kinds of elements that can be included | 2214 An enumeration of the kinds of elements that can be included |
2208 in a completion suggestion. | 2215 in a completion suggestion. |
2209 </p> | 2216 </p> |
2210 <enum> | 2217 <enum> |
2211 <value> | 2218 <value> |
2212 <code>ARGUMENT_LIST</code> | 2219 <code>ARGUMENT_LIST</code> |
(...skipping 23 matching lines...) Expand all Loading... |
2236 and the completion field is the element's identifier. | 2243 and the completion field is the element's identifier. |
2237 </p> | 2244 </p> |
2238 </value> | 2245 </value> |
2239 <value> | 2246 <value> |
2240 <code>KEYWORD</code> | 2247 <code>KEYWORD</code> |
2241 <p> | 2248 <p> |
2242 A keyword is being suggested. | 2249 A keyword is being suggested. |
2243 For suggestions of this kind, the completion is the keyword. | 2250 For suggestions of this kind, the completion is the keyword. |
2244 </p> | 2251 </p> |
2245 </value> | 2252 </value> |
2246 <value><code>NAMED_ARGUMENT</code></value> | 2253 <value> |
| 2254 <code>NAMED_ARGUMENT</code> |
| 2255 <p> |
| 2256 A named argument for the current callsite is being suggested. |
| 2257 For suggestions of this kind, the completion is |
| 2258 the named argument identifier including a trailing ':' and space. |
| 2259 </p> |
| 2260 </value> |
2247 <value><code>OPTIONAL_ARGUMENT</code></value> | 2261 <value><code>OPTIONAL_ARGUMENT</code></value> |
2248 <value><code>PARAMETER</code></value> | 2262 <value><code>PARAMETER</code></value> |
2249 </enum> | 2263 </enum> |
2250 </type> | 2264 </type> |
2251 <type name="Element"> | 2265 <type name="Element"> |
2252 <p> | 2266 <p> |
2253 Information about an element (something that can be declared | 2267 Information about an element (something that can be declared |
2254 in code). | 2268 in code). |
2255 </p> | 2269 </p> |
2256 <object> | 2270 <object> |
(...skipping 1633 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
3890 <h2>Errors</h2> | 3904 <h2>Errors</h2> |
3891 <p> | 3905 <p> |
3892 This section contains a list of all of the errors that are | 3906 This section contains a list of all of the errors that are |
3893 produced by the server and the data that is returned with each. | 3907 produced by the server and the data that is returned with each. |
3894 </p> | 3908 </p> |
3895 <p> | 3909 <p> |
3896 TBD | 3910 TBD |
3897 </p> | 3911 </p> |
3898 </body> | 3912 </body> |
3899 </html> | 3913 </html> |
OLD | NEW |