| 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">WORKING DRAFT - Version <version>0.3</version></h1
> | 8 <h1 style="color:#999999">WORKING DRAFT - Version <version>0.3</version></h1
> |
| 9 <p> | 9 <p> |
| 10 This document contains a specification of the API provided by | 10 This document contains a specification of the API provided by |
| (...skipping 184 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 195 problems with specific requests (which are returned as part | 195 problems with specific requests (which are returned as part |
| 196 of the response) but is used for exceptions that occur while | 196 of the response) but is used for exceptions that occur while |
| 197 performing other tasks, such as analysis or preparing | 197 performing other tasks, such as analysis or preparing |
| 198 notifications. | 198 notifications. |
| 199 </p> | 199 </p> |
| 200 <p> | 200 <p> |
| 201 It is not possible to subscribe to or unsubscribe from this | 201 It is not possible to subscribe to or unsubscribe from this |
| 202 notification. | 202 notification. |
| 203 </p> | 203 </p> |
| 204 <params> | 204 <params> |
| 205 <field name="fatal"> | 205 <field name="isFatal"> |
| 206 <ref>bool</ref> | 206 <ref>bool</ref> |
| 207 <p> | 207 <p> |
| 208 True if the error is a fatal error, meaning that the | 208 True if the error is a fatal error, meaning that the |
| 209 server will shutdown automatically after sending this | 209 server will shutdown automatically after sending this |
| 210 notification. | 210 notification. |
| 211 </p> | 211 </p> |
| 212 </field> | 212 </field> |
| 213 <field name="message"> | 213 <field name="message"> |
| 214 <ref>String</ref> | 214 <ref>String</ref> |
| 215 <p> | 215 <p> |
| (...skipping 594 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 810 <list><ref>CompletionSuggestion</ref></list> | 810 <list><ref>CompletionSuggestion</ref></list> |
| 811 <p> | 811 <p> |
| 812 The completion suggestions being reported. The | 812 The completion suggestions being reported. The |
| 813 notification contains all possible completions at the | 813 notification contains all possible completions at the |
| 814 requested cursor position, even those that do not match | 814 requested cursor position, even those that do not match |
| 815 the characters the user has already typed. This allows | 815 the characters the user has already typed. This allows |
| 816 the client to respond to further keystrokes from the | 816 the client to respond to further keystrokes from the |
| 817 user without having to make additional requests. | 817 user without having to make additional requests. |
| 818 </p> | 818 </p> |
| 819 </field> | 819 </field> |
| 820 <field name="last"> | 820 <field name="isLast"> |
| 821 <ref>bool</ref> | 821 <ref>bool</ref> |
| 822 <p> | 822 <p> |
| 823 True if this is that last set of results that will be | 823 True if this is that last set of results that will be |
| 824 returned for the indicated completion. | 824 returned for the indicated completion. |
| 825 </p> | 825 </p> |
| 826 </field> | 826 </field> |
| 827 </params> | 827 </params> |
| 828 </notification> | 828 </notification> |
| 829 </domain> | 829 </domain> |
| 830 <domain name="search"> | 830 <domain name="search"> |
| (...skipping 198 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 1029 <p> | 1029 <p> |
| 1030 The id associated with the search. | 1030 The id associated with the search. |
| 1031 </p> | 1031 </p> |
| 1032 </field> | 1032 </field> |
| 1033 <field name="results"> | 1033 <field name="results"> |
| 1034 <list><ref>SearchResult</ref></list> | 1034 <list><ref>SearchResult</ref></list> |
| 1035 <p> | 1035 <p> |
| 1036 The search results being reported. | 1036 The search results being reported. |
| 1037 </p> | 1037 </p> |
| 1038 </field> | 1038 </field> |
| 1039 <field name="last"> | 1039 <field name="isLast"> |
| 1040 <ref>bool</ref> | 1040 <ref>bool</ref> |
| 1041 <p> | 1041 <p> |
| 1042 True if this is that last set of results that will be | 1042 True if this is that last set of results that will be |
| 1043 returned for the indicated search. | 1043 returned for the indicated search. |
| 1044 </p> | 1044 </p> |
| 1045 </field> | 1045 </field> |
| 1046 </params> | 1046 </params> |
| 1047 </notification> | 1047 </notification> |
| 1048 </domain> | 1048 </domain> |
| 1049 <domain name="edit"> | 1049 <domain name="edit"> |
| (...skipping 497 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 1547 <value><code>OCCURRENCES</code></value> | 1547 <value><code>OCCURRENCES</code></value> |
| 1548 <value><code>OUTLINE</code></value> | 1548 <value><code>OUTLINE</code></value> |
| 1549 <value><code>OVERRIDES</code></value> | 1549 <value><code>OVERRIDES</code></value> |
| 1550 </enum> | 1550 </enum> |
| 1551 </type> | 1551 </type> |
| 1552 <type name="AnalysisStatus"> | 1552 <type name="AnalysisStatus"> |
| 1553 <p> | 1553 <p> |
| 1554 An indication of the current state of analysis. | 1554 An indication of the current state of analysis. |
| 1555 </p> | 1555 </p> |
| 1556 <object> | 1556 <object> |
| 1557 <field name="analyzing"> | 1557 <field name="isAnalyzing"> |
| 1558 <ref>bool</ref> | 1558 <ref>bool</ref> |
| 1559 <p>True if analysis is currently being performed.</p> | 1559 <p>True if analysis is currently being performed.</p> |
| 1560 </field> | 1560 </field> |
| 1561 <field name="analysisTarget" optional="true"> | 1561 <field name="analysisTarget" optional="true"> |
| 1562 <ref>String</ref> | 1562 <ref>String</ref> |
| 1563 <p> | 1563 <p> |
| 1564 The name of the current target of analysis. This field is | 1564 The name of the current target of analysis. This field is |
| 1565 omitted if analyzing is false. | 1565 omitted if analyzing is false. |
| 1566 </p> | 1566 </p> |
| 1567 </field> | 1567 </field> |
| (...skipping 1560 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 3128 <h2>Errors</h2> | 3128 <h2>Errors</h2> |
| 3129 <p> | 3129 <p> |
| 3130 This section contains a list of all of the errors that are | 3130 This section contains a list of all of the errors that are |
| 3131 produced by the server and the data that is returned with each. | 3131 produced by the server and the data that is returned with each. |
| 3132 </p> | 3132 </p> |
| 3133 <p> | 3133 <p> |
| 3134 TBD | 3134 TBD |
| 3135 </p> | 3135 </p> |
| 3136 </body> | 3136 </body> |
| 3137 </html> | 3137 </html> |
| OLD | NEW |