| 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 1205 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 1216 refactoring being performed. The data that is expected is | 1216 refactoring being performed. The data that is expected is |
| 1217 documented in the section titled <a | 1217 documented in the section titled <a |
| 1218 href="#refactorings">Refactorings</a>, labeled as | 1218 href="#refactorings">Refactorings</a>, labeled as |
| 1219 “Options”. This field can be omitted if the refactoring | 1219 “Options”. This field can be omitted if the refactoring |
| 1220 does not require any options or if the values of those | 1220 does not require any options or if the values of those |
| 1221 options are not known. | 1221 options are not known. |
| 1222 </p> | 1222 </p> |
| 1223 </field> | 1223 </field> |
| 1224 </params> | 1224 </params> |
| 1225 <result> | 1225 <result> |
| 1226 <field name="problems"> | 1226 <field name="initialProblems"> |
| 1227 <list><ref>RefactoringProblem</ref></list> | 1227 <list><ref>RefactoringProblem</ref></list> |
| 1228 <p> | 1228 <p> |
| 1229 The status of the refactoring. The array will be empty | 1229 The initial status of the refactoring, i.e. problems related to |
| 1230 if there are no known problems. | 1230 the context in which the refactoring is requested. |
| 1231 The array will be empty if there are no known problems. |
| 1232 </p> |
| 1233 </field> |
| 1234 <field name="optionsProblems"> |
| 1235 <list><ref>RefactoringProblem</ref></list> |
| 1236 <p> |
| 1237 The options validation status, i.e. problems in the given options, |
| 1238 such as light-weight validation of a new name, flags |
| 1239 compatibility, etc. |
| 1240 The array will be empty if there are no known problems. |
| 1241 </p> |
| 1242 </field> |
| 1243 <field name="finalProblems"> |
| 1244 <list><ref>RefactoringProblem</ref></list> |
| 1245 <p> |
| 1246 The final status of the refactoring, i.e. problems identified in |
| 1247 the result of a full, potentially expensive validation and / or |
| 1248 change creation. |
| 1249 The array will be empty if there are no known problems. |
| 1231 </p> | 1250 </p> |
| 1232 </field> | 1251 </field> |
| 1233 <field name="feedback" optional="true"> | 1252 <field name="feedback" optional="true"> |
| 1234 <ref>RefactoringFeedback</ref> | 1253 <ref>RefactoringFeedback</ref> |
| 1235 <p> | 1254 <p> |
| 1236 Data used to provide feedback to the user. The structure | 1255 Data used to provide feedback to the user. The structure |
| 1237 of the data is dependent on the kind of refactoring | 1256 of the data is dependent on the kind of refactoring |
| 1238 being created. The data that is returned is documented | 1257 being created. The data that is returned is documented |
| 1239 in the section titled <a | 1258 in the section titled <a |
| 1240 href="#refactorings">Refactorings</a>, labeled as | 1259 href="#refactorings">Refactorings</a>, labeled as |
| (...skipping 2045 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 3286 <h2>Errors</h2> | 3305 <h2>Errors</h2> |
| 3287 <p> | 3306 <p> |
| 3288 This section contains a list of all of the errors that are | 3307 This section contains a list of all of the errors that are |
| 3289 produced by the server and the data that is returned with each. | 3308 produced by the server and the data that is returned with each. |
| 3290 </p> | 3309 </p> |
| 3291 <p> | 3310 <p> |
| 3292 TBD | 3311 TBD |
| 3293 </p> | 3312 </p> |
| 3294 </body> | 3313 </body> |
| 3295 </html> | 3314 </html> |
| OLD | NEW |