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 Plugin API Specification</title> | 5 <title>Analysis Server Plugin API Specification</title> |
6 </head> | 6 </head> |
7 <body> | 7 <body> |
8 <h1>Analysis Server Plugin API Specification</h1> | 8 <h1>Analysis Server Plugin API Specification</h1> |
9 <h1 style="color:#999999">Version | 9 <h1 style="color:#999999">Version |
10 <version>1.0.0-alpha.0</version> | 10 <version>1.0.0-alpha.0</version> |
(...skipping 20 matching lines...) Expand all Loading... |
31 <p> | 31 <p> |
32 TODO: Add a notification to the server protocol to inform the client of | 32 TODO: Add a notification to the server protocol to inform the client of |
33 problems related to the execution of plugins. | 33 problems related to the execution of plugins. |
34 </p> | 34 </p> |
35 <request method="versionCheck"> | 35 <request method="versionCheck"> |
36 <p> | 36 <p> |
37 Used to request that the plugin perform a version check to confirm that it | 37 Used to request that the plugin perform a version check to confirm that it |
38 works with the version of the analysis server that is executing it. | 38 works with the version of the analysis server that is executing it. |
39 </p> | 39 </p> |
40 <params> | 40 <params> |
| 41 <field name="byteStorePath"> |
| 42 <ref>String</ref> |
| 43 <p> |
| 44 The path to the directory containing the on-disk byte store that is to |
| 45 be used by any analysis drivers that are created. |
| 46 </p> |
| 47 </field> |
41 <field name="version"> | 48 <field name="version"> |
42 <ref>String</ref> | 49 <ref>String</ref> |
43 <p> | 50 <p> |
44 The version number of the plugin spec supported by the analysis server | 51 The version number of the plugin spec supported by the analysis server |
45 that is executing the plugin. | 52 that is executing the plugin. |
46 </p> | 53 </p> |
47 </field> | 54 </field> |
48 </params> | 55 </params> |
49 <result> | 56 <result> |
50 <field name="isCompatible"> | 57 <field name="isCompatible"> |
(...skipping 12 matching lines...) Expand all Loading... |
63 </p> | 70 </p> |
64 </field> | 71 </field> |
65 <field name="version"> | 72 <field name="version"> |
66 <ref>String</ref> | 73 <ref>String</ref> |
67 <p> | 74 <p> |
68 The version of the plugin. This value is only used when the server | 75 The version of the plugin. This value is only used when the server |
69 needs to identify the plugin, either to the user or for debugging | 76 needs to identify the plugin, either to the user or for debugging |
70 purposes. | 77 purposes. |
71 </p> | 78 </p> |
72 </field> | 79 </field> |
73 <field name="email" optional="true"> | 80 <field name="contactInfo" optional="true"> |
74 <ref>String</ref> | 81 <ref>String</ref> |
75 <p> | 82 <p> |
76 An e-mail address that either the client or the user can use to | 83 Information that the user can use to use to contact the maintainers of |
77 contact the maintainers of the plugin when there is a problem. | 84 the plugin when there is a problem. |
78 </p> | 85 </p> |
79 </field> | 86 </field> |
80 <field name="interestingFiles"> | 87 <field name="interestingFiles"> |
81 <list> | 88 <list> |
82 <ref>String</ref> | 89 <ref>String</ref> |
83 </list> | 90 </list> |
84 <p> | 91 <p> |
85 The glob patterns of the files for which the plugin will provide | 92 The glob patterns of the files for which the plugin will provide |
86 information. This value is ignored if the <tt>isCompatible</tt> | 93 information. This value is ignored if the <tt>isCompatible</tt> |
87 field is <tt>false</tt>. Otherwise, it will be used to identify | 94 field is <tt>false</tt>. Otherwise, it will be used to identify |
(...skipping 2683 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
2771 The name that the element should have after the refactoring. | 2778 The name that the element should have after the refactoring. |
2772 </p> | 2779 </p> |
2773 </field> | 2780 </field> |
2774 </options> | 2781 </options> |
2775 </refactoring> | 2782 </refactoring> |
2776 </refactorings> | 2783 </refactorings> |
2777 <h2 class="domain"><a name="index">Index</a></h2> | 2784 <h2 class="domain"><a name="index">Index</a></h2> |
2778 <index></index> | 2785 <index></index> |
2779 </body> | 2786 </body> |
2780 </html> | 2787 </html> |
OLD | NEW |