| 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 1373 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 1384 </p> | 1384 </p> |
| 1385 </dd></dl></dd><dt class="request">edit.getRefactoring</dt><dd><div cl
ass="box"><pre>request: { | 1385 </dd></dl></dd><dt class="request">edit.getRefactoring</dt><dd><div cl
ass="box"><pre>request: { |
| 1386 "id": String | 1386 "id": String |
| 1387 "method": "edit.getRefactoring" | 1387 "method": "edit.getRefactoring" |
| 1388 "params": { | 1388 "params": { |
| 1389 "<b>kind</b>": <a href="#type_RefactoringKind">RefactoringKind</a> | 1389 "<b>kind</b>": <a href="#type_RefactoringKind">RefactoringKind</a> |
| 1390 "<b>file</b>": <a href="#type_FilePath">FilePath</a> | 1390 "<b>file</b>": <a href="#type_FilePath">FilePath</a> |
| 1391 "<b>offset</b>": int | 1391 "<b>offset</b>": int |
| 1392 "<b>length</b>": int | 1392 "<b>length</b>": int |
| 1393 "<b>validateOnly</b>": bool | 1393 "<b>validateOnly</b>": bool |
| 1394 "<b>options</b>": <span style="color:#999999">optional</span> object | 1394 "<b>options</b>": <span style="color:#999999">optional</span> <a href="#type
_RefactoringOptions">RefactoringOptions</a> |
| 1395 } | 1395 } |
| 1396 }</pre><br><pre>response: { | 1396 }</pre><br><pre>response: { |
| 1397 "id": String | 1397 "id": String |
| 1398 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr
or">RequestError</a> | 1398 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr
or">RequestError</a> |
| 1399 "result": { | 1399 "result": { |
| 1400 "<b>problems</b>": List<<a href="#type_RefactoringProblem">RefactoringPro
blem</a>> | 1400 "<b>problems</b>": List<<a href="#type_RefactoringProblem">RefactoringPro
blem</a>> |
| 1401 "<b>feedback</b>": <span style="color:#999999">optional</span> object | 1401 "<b>feedback</b>": <span style="color:#999999">optional</span> object |
| 1402 "<b>change</b>": <span style="color:#999999">optional</span> <a href="#type_
SourceChange">SourceChange</a> | 1402 "<b>change</b>": <span style="color:#999999">optional</span> <a href="#type_
SourceChange">SourceChange</a> |
| 1403 "<b>potentialEdits</b>": <span style="color:#999999">optional</span> List<
;String> | 1403 "<b>potentialEdits</b>": <span style="color:#999999">optional</span> List<
;String> |
| 1404 } | 1404 } |
| (...skipping 23 matching lines...) Expand all Loading... |
| 1428 | 1428 |
| 1429 <p> | 1429 <p> |
| 1430 The length of the region involved in the refactoring. | 1430 The length of the region involved in the refactoring. |
| 1431 </p> | 1431 </p> |
| 1432 </dd><dt class="field"><b><i>validateOnly ( bool )</i></b></dt><dd> | 1432 </dd><dt class="field"><b><i>validateOnly ( bool )</i></b></dt><dd> |
| 1433 | 1433 |
| 1434 <p> | 1434 <p> |
| 1435 True if the client is only requesting that the values of | 1435 True if the client is only requesting that the values of |
| 1436 the options be validated and no change be generated. | 1436 the options be validated and no change be generated. |
| 1437 </p> | 1437 </p> |
| 1438 </dd><dt class="field"><b><i>options ( <span style="color:#999999">opt
ional</span> object )</i></b></dt><dd> | 1438 </dd><dt class="field"><b><i>options ( <span style="color:#999999">opt
ional</span> <a href="#type_RefactoringOptions">RefactoringOptions</a> )</i></b>
</dt><dd> |
| 1439 | 1439 |
| 1440 <p> | 1440 <p> |
| 1441 Data used to provide values provided by the user. The | 1441 Data used to provide values provided by the user. The |
| 1442 structure of the data is dependent on the kind of | 1442 structure of the data is dependent on the kind of |
| 1443 refactoring being performed. The data that is expected is | 1443 refactoring being performed. The data that is expected is |
| 1444 documented in the section titled <a href="#refactorings">Refactori
ngs</a>, labeled as | 1444 documented in the section titled <a href="#refactorings">Refactori
ngs</a>, labeled as |
| 1445 “Options”. This field can be omitted if the refactoring | 1445 “Options”. This field can be omitted if the refactoring |
| 1446 does not require any options or if the values of those | 1446 does not require any options or if the values of those |
| 1447 options are not known. | 1447 options are not known. |
| 1448 </p> | 1448 </p> |
| (...skipping 267 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 1716 | 1716 |
| 1717 | 1717 |
| 1718 | 1718 |
| 1719 | 1719 |
| 1720 | 1720 |
| 1721 | 1721 |
| 1722 | 1722 |
| 1723 | 1723 |
| 1724 | 1724 |
| 1725 | 1725 |
| 1726 |
| 1726 <dl><dt class="typeDefinition"><a name="type_AddContentOverlay">AddContentOv
erlay: object</a></dt><dd> | 1727 <dl><dt class="typeDefinition"><a name="type_AddContentOverlay">AddContentOv
erlay: object</a></dt><dd> |
| 1727 <p> | 1728 <p> |
| 1728 A directive to begin overlaying the contents of a file. The | 1729 A directive to begin overlaying the contents of a file. The |
| 1729 supplied content will be used for analysis in place of the | 1730 supplied content will be used for analysis in place of the |
| 1730 file contents in the filesystem. | 1731 file contents in the filesystem. |
| 1731 </p> | 1732 </p> |
| 1732 <p> | 1733 <p> |
| 1733 If this directive is used on a file that already has a file | 1734 If this directive is used on a file that already has a file |
| 1734 content overlay, the old overlay is discarded and replaced | 1735 content overlay, the old overlay is discarded and replaced |
| 1735 with the new one. | 1736 with the new one. |
| (...skipping 761 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 2497 The name that should be given to the parameter. | 2498 The name that should be given to the parameter. |
| 2498 </p> | 2499 </p> |
| 2499 </dd><dt class="field"><b><i>parameters ( <span style="color:#999999">
optional</span> String )</i></b></dt><dd> | 2500 </dd><dt class="field"><b><i>parameters ( <span style="color:#999999">
optional</span> String )</i></b></dt><dd> |
| 2500 | 2501 |
| 2501 <p> | 2502 <p> |
| 2502 The parameter list of the parameter's function type. | 2503 The parameter list of the parameter's function type. |
| 2503 If the parameter is not of a function type, this field will | 2504 If the parameter is not of a function type, this field will |
| 2504 not be defined. If the function type has zero parameters, this | 2505 not be defined. If the function type has zero parameters, this |
| 2505 field will have a value of "()". | 2506 field will have a value of "()". |
| 2506 </p> | 2507 </p> |
| 2507 </dd></dl></dd><dt class="typeDefinition"><a name="type_RefactoringMet
hodParameterKind">RefactoringMethodParameterKind: String</a></dt><dd> | 2508 </dd></dl></dd><dt class="typeDefinition"><a name="type_RefactoringOpt
ions">RefactoringOptions: object</a></dt><dd> |
| 2509 <p> |
| 2510 An abstract superclass of all refactoring options. |
| 2511 </p> |
| 2512 |
| 2513 <dl></dl></dd><dt class="typeDefinition"><a name="type_RefactoringMethodPa
rameterKind">RefactoringMethodParameterKind: String</a></dt><dd> |
| 2508 <p> | 2514 <p> |
| 2509 An enumeration of the kinds of parameters. | 2515 An enumeration of the kinds of parameters. |
| 2510 </p> | 2516 </p> |
| 2511 | 2517 |
| 2512 <dl><dt class="value">REQUIRED</dt><dt class="value">POSITIONAL</dt><dt cl
ass="value">NAMED</dt></dl></dd><dt class="typeDefinition"><a name="type_Refacto
ringProblem">RefactoringProblem: object</a></dt><dd> | 2518 <dl><dt class="value">REQUIRED</dt><dt class="value">POSITIONAL</dt><dt cl
ass="value">NAMED</dt></dl></dd><dt class="typeDefinition"><a name="type_Refacto
ringProblem">RefactoringProblem: object</a></dt><dd> |
| 2513 <p> | 2519 <p> |
| 2514 A description of a problem related to a refactoring. | 2520 A description of a problem related to a refactoring. |
| 2515 </p> | 2521 </p> |
| 2516 | 2522 |
| 2517 <dl><dt class="field"><b><i>severity ( <a href="#type_RefactoringProblemSe
verity">RefactoringProblemSeverity</a> )</i></b></dt><dd> | 2523 <dl><dt class="field"><b><i>severity ( <a href="#type_RefactoringProblemSe
verity">RefactoringProblemSeverity</a> )</i></b></dt><dd> |
| (...skipping 580 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 3098 <p> | 3104 <p> |
| 3099 This section contains a list of all of the errors that are | 3105 This section contains a list of all of the errors that are |
| 3100 produced by the server and the data that is returned with each. | 3106 produced by the server and the data that is returned with each. |
| 3101 </p> | 3107 </p> |
| 3102 <p> | 3108 <p> |
| 3103 TBD | 3109 TBD |
| 3104 </p> | 3110 </p> |
| 3105 | 3111 |
| 3106 | 3112 |
| 3107 </body></html> | 3113 </body></html> |
| OLD | NEW |