OLD | NEW |
1 <html><head> | 1 <html><head> |
2 <meta charset="UTF-8"> | 2 <meta charset="UTF-8"> |
3 <title>Analysis Server API Specification</title> | 3 <title>Analysis Server API Specification</title> |
4 <style>body { | 4 <style>body { |
5 font-family: sans-serif, serif; | 5 font-family: sans-serif, serif; |
6 padding-left: 5%; | 6 padding-left: 5%; |
7 padding-right: 5%; | 7 padding-right: 5%; |
8 } | 8 } |
9 h1 { | 9 h1 { |
10 text-align: center; | 10 text-align: center; |
(...skipping 25 matching lines...) Expand all Loading... |
36 } | 36 } |
37 dt.request { | 37 dt.request { |
38 font-weight: bold; | 38 font-weight: bold; |
39 } | 39 } |
40 dt.typeDefinition { | 40 dt.typeDefinition { |
41 font-weight: bold; | 41 font-weight: bold; |
42 } | 42 } |
43 </style></head> | 43 </style></head> |
44 <body> | 44 <body> |
45 <h1>Analysis Server API Specification</h1> | 45 <h1>Analysis Server API Specification</h1> |
46 <h1 style="color:#999999">Version 1.6.0</h1> | 46 <h1 style="color:#999999">Version 1.6.1</h1> |
47 <p> | 47 <p> |
48 This document contains a specification of the API provided by the | 48 This document contains a specification of the API provided by the |
49 analysis server. The API in this document is currently under | 49 analysis server. The API in this document is currently under |
50 development. Changes to the API will be accompanied by an update to the | 50 development. Changes to the API will be accompanied by an update to the |
51 protocol version number according to the principles of semantic | 51 protocol version number according to the principles of semantic |
52 versioning <a href="http://semver.org/">http://semver.org/</a>. | 52 versioning <a href="http://semver.org/">http://semver.org/</a>. |
53 </p> | 53 </p> |
54 <h2>Overview</h2> | 54 <h2>Overview</h2> |
55 <p> | 55 <p> |
56 The analysis server API is a bi-directional client-server | 56 The analysis server API is a bi-directional client-server |
(...skipping 2381 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
2438 The name of the optional parameter being suggested. This | 2438 The name of the optional parameter being suggested. This |
2439 field is omitted if the suggestion is not the addition of | 2439 field is omitted if the suggestion is not the addition of |
2440 an optional argument within an argument list. | 2440 an optional argument within an argument list. |
2441 </p> | 2441 </p> |
2442 </dd><dt class="field"><b><i>parameterType ( <span style="color:#99999
9">optional</span> String )</i></b></dt><dd> | 2442 </dd><dt class="field"><b><i>parameterType ( <span style="color:#99999
9">optional</span> String )</i></b></dt><dd> |
2443 | 2443 |
2444 <p> | 2444 <p> |
2445 The type of the options parameter being suggested. This | 2445 The type of the options parameter being suggested. This |
2446 field is omitted if the parameterName field is omitted. | 2446 field is omitted if the parameterName field is omitted. |
2447 </p> | 2447 </p> |
| 2448 </dd><dt class="field"><b><i>importUri ( <span style="color:#999999">o
ptional</span> String )</i></b></dt><dd> |
| 2449 |
| 2450 <p> |
| 2451 The import to be added if the suggestion is out of scope |
| 2452 and needs an import to be added to be in scope. |
| 2453 </p> |
2448 </dd></dl></dd><dt class="typeDefinition"><a name="type_CompletionSugg
estionKind">CompletionSuggestionKind: String</a></dt><dd> | 2454 </dd></dl></dd><dt class="typeDefinition"><a name="type_CompletionSugg
estionKind">CompletionSuggestionKind: String</a></dt><dd> |
2449 <p> | 2455 <p> |
2450 An enumeration of the kinds of elements that can be included | 2456 An enumeration of the kinds of elements that can be included |
2451 in a completion suggestion. | 2457 in a completion suggestion. |
2452 </p> | 2458 </p> |
2453 | 2459 |
2454 <dl><dt class="value">ARGUMENT_LIST</dt><dd> | 2460 <dl><dt class="value">ARGUMENT_LIST</dt><dd> |
2455 | 2461 |
2456 <p> | 2462 <p> |
2457 A list of arguments for the method or function that is being invok
ed. | 2463 A list of arguments for the method or function that is being invok
ed. |
(...skipping 16 matching lines...) Expand all Loading... |
2474 For example, "someMethod" in x.someMethod(); . | 2480 For example, "someMethod" in x.someMethod(); . |
2475 For suggestions of this kind, the element attribute is defined | 2481 For suggestions of this kind, the element attribute is defined |
2476 and the completion field is the element's identifier. | 2482 and the completion field is the element's identifier. |
2477 </p> | 2483 </p> |
2478 </dd><dt class="value">KEYWORD</dt><dd> | 2484 </dd><dt class="value">KEYWORD</dt><dd> |
2479 | 2485 |
2480 <p> | 2486 <p> |
2481 A keyword is being suggested. | 2487 A keyword is being suggested. |
2482 For suggestions of this kind, the completion is the keyword. | 2488 For suggestions of this kind, the completion is the keyword. |
2483 </p> | 2489 </p> |
2484 </dd><dt class="value">NAMED_ARGUMENT</dt><dt class="value">OPTIONAL_A
RGUMENT</dt><dt class="value">PARAMETER</dt></dl></dd><dt class="typeDefinition"
><a name="type_Element">Element: object</a></dt><dd> | 2490 </dd><dt class="value">NAMED_ARGUMENT</dt><dd> |
| 2491 |
| 2492 <p> |
| 2493 A named argument for the current callsite is being suggested. |
| 2494 For suggestions of this kind, the completion is |
| 2495 the named argument identifier including a trailing ':' and space. |
| 2496 </p> |
| 2497 </dd><dt class="value">OPTIONAL_ARGUMENT</dt><dt class="value">PARAMET
ER</dt></dl></dd><dt class="typeDefinition"><a name="type_Element">Element: obje
ct</a></dt><dd> |
2485 <p> | 2498 <p> |
2486 Information about an element (something that can be declared | 2499 Information about an element (something that can be declared |
2487 in code). | 2500 in code). |
2488 </p> | 2501 </p> |
2489 | 2502 |
2490 <dl><dt class="field"><b><i>kind ( <a href="#type_ElementKind">ElementKind
</a> )</i></b></dt><dd> | 2503 <dl><dt class="field"><b><i>kind ( <a href="#type_ElementKind">ElementKind
</a> )</i></b></dt><dd> |
2491 | 2504 |
2492 <p> | 2505 <p> |
2493 The kind of the element. | 2506 The kind of the element. |
2494 </p> | 2507 </p> |
(...skipping 1294 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
3789 <p> | 3802 <p> |
3790 This section contains a list of all of the errors that are | 3803 This section contains a list of all of the errors that are |
3791 produced by the server and the data that is returned with each. | 3804 produced by the server and the data that is returned with each. |
3792 </p> | 3805 </p> |
3793 <p> | 3806 <p> |
3794 TBD | 3807 TBD |
3795 </p> | 3808 </p> |
3796 | 3809 |
3797 | 3810 |
3798 </body></html> | 3811 </body></html> |
OLD | NEW |