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.13.0</version></h1> | 9 <h1 style="color:#999999">Version <version>1.14.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/">http://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 2667 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
2687 An enumeration of the kinds of files. | 2687 An enumeration of the kinds of files. |
2688 </p> | 2688 </p> |
2689 <enum> | 2689 <enum> |
2690 <value><code>LIBRARY</code></value> | 2690 <value><code>LIBRARY</code></value> |
2691 <value><code>PART</code></value> | 2691 <value><code>PART</code></value> |
2692 </enum> | 2692 </enum> |
2693 </type> | 2693 </type> |
2694 <type name="FilePath"> | 2694 <type name="FilePath"> |
2695 <ref>String</ref> | 2695 <ref>String</ref> |
2696 <p> | 2696 <p> |
2697 The absolute path of a file. | 2697 The absolute, normalized path of a file. |
| 2698 </p> |
| 2699 <p> |
| 2700 If the format of a file path in a request is not valid, e.g. the |
| 2701 path is not absolute or is not normalized, then an error of type |
| 2702 <tt>INVALID_FILE_PATH_FORMAT</tt> will be generated. |
2698 </p> | 2703 </p> |
2699 </type> | 2704 </type> |
2700 <type name="FoldingKind"> | 2705 <type name="FoldingKind"> |
2701 <p> | 2706 <p> |
2702 An enumeration of the kinds of folding regions. | 2707 An enumeration of the kinds of folding regions. |
2703 </p> | 2708 </p> |
2704 <enum> | 2709 <enum> |
2705 <value><code>COMMENT</code></value> | 2710 <value><code>COMMENT</code></value> |
2706 <value><code>CLASS_MEMBER</code></value> | 2711 <value><code>CLASS_MEMBER</code></value> |
2707 <value><code>DIRECTIVES</code></value> | 2712 <value><code>DIRECTIVES</code></value> |
(...skipping 993 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
3701 </p> | 3706 </p> |
3702 </value> | 3707 </value> |
3703 <value> | 3708 <value> |
3704 <code>INVALID_EXECUTION_CONTEXT</code> | 3709 <code>INVALID_EXECUTION_CONTEXT</code> |
3705 <p> | 3710 <p> |
3706 The context root used to create an execution context does not | 3711 The context root used to create an execution context does not |
3707 exist. | 3712 exist. |
3708 </p> | 3713 </p> |
3709 </value> | 3714 </value> |
3710 <value> | 3715 <value> |
| 3716 <code>INVALID_FILE_PATH_FORMAT</code> |
| 3717 <p> |
| 3718 The format of the given file path is invalid, e.g. is not |
| 3719 absolute and normalized. |
| 3720 </p> |
| 3721 </value> |
| 3722 <value> |
3711 <code>INVALID_OVERLAY_CHANGE</code> | 3723 <code>INVALID_OVERLAY_CHANGE</code> |
3712 <p> | 3724 <p> |
3713 An "analysis.updateContent" request contained a | 3725 An "analysis.updateContent" request contained a |
3714 ChangeContentOverlay object which can't be applied, due | 3726 ChangeContentOverlay object which can't be applied, due |
3715 to an edit having an offset or length that is out of | 3727 to an edit having an offset or length that is out of |
3716 range. | 3728 range. |
3717 </p> | 3729 </p> |
3718 </value> | 3730 </value> |
3719 <value> | 3731 <value> |
3720 <code>INVALID_PARAMETER</code> | 3732 <code>INVALID_PARAMETER</code> |
(...skipping 753 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
4474 This section contains a list of all of the errors that are | 4486 This section contains a list of all of the errors that are |
4475 produced by the server and the data that is returned with each. | 4487 produced by the server and the data that is returned with each. |
4476 </p> | 4488 </p> |
4477 <p> | 4489 <p> |
4478 TBD | 4490 TBD |
4479 </p> | 4491 </p> |
4480 <h2 class="domain"><a name="index">Index</a></h2> | 4492 <h2 class="domain"><a name="index">Index</a></h2> |
4481 <index></index> | 4493 <index></index> |
4482 </body> | 4494 </body> |
4483 </html> | 4495 </html> |
OLD | NEW |