Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(103)

Side by Side Diff: pkg/analysis_server/doc/api.html

Issue 472373002: Support potential edits (Closed) Base URL: https://dart.googlecode.com/svn/branches/bleeding_edge/dart
Patch Set: Created 6 years, 4 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch | Annotate | Revision Log
OLDNEW
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 1374 matching lines...) Expand 10 before | Expand all | Expand 10 after
1385 "<b>validateOnly</b>": bool 1385 "<b>validateOnly</b>": bool
1386 "<b>options</b>": <span style="color:#999999">optional</span> object 1386 "<b>options</b>": <span style="color:#999999">optional</span> object
1387 } 1387 }
1388 }</pre><br><pre>response: { 1388 }</pre><br><pre>response: {
1389 "id": String 1389 "id": String
1390 "error": <span style="color:#999999">optional</span> <a href="#type_Error">Err or</a> 1390 "error": <span style="color:#999999">optional</span> <a href="#type_Error">Err or</a>
1391 "result": { 1391 "result": {
1392 "<b>status</b>": List&lt;<a href="#type_RefactoringProblem">RefactoringProbl em</a>&gt; 1392 "<b>status</b>": List&lt;<a href="#type_RefactoringProblem">RefactoringProbl em</a>&gt;
1393 "<b>feedback</b>": <span style="color:#999999">optional</span> object 1393 "<b>feedback</b>": <span style="color:#999999">optional</span> object
1394 "<b>change</b>": <span style="color:#999999">optional</span> <a href="#type_ SourceChange">SourceChange</a> 1394 "<b>change</b>": <span style="color:#999999">optional</span> <a href="#type_ SourceChange">SourceChange</a>
1395 "<b>potentialChanges</b>": <span style="color:#999999">optional</span> List& lt;String&gt;
1395 } 1396 }
1396 }</pre></div> 1397 }</pre></div>
1397 <p> 1398 <p>
1398 Get the changes required to perform a refactoring. 1399 Get the changes required to perform a refactoring.
1399 </p> 1400 </p>
1400 1401
1401 1402
1402 <h4>Parameters</h4><dl><dt class="field"><b><i>kindId ( <a href="#type_Ref actoringKind">RefactoringKind</a> )</i></b></dt><dd> 1403 <h4>Parameters</h4><dl><dt class="field"><b><i>kindId ( <a href="#type_Ref actoringKind">RefactoringKind</a> )</i></b></dt><dd>
1403 1404
1404 <p> 1405 <p>
(...skipping 46 matching lines...) Expand 10 before | Expand all | Expand 10 after
1451 of the data is dependent on the kind of refactoring 1452 of the data is dependent on the kind of refactoring
1452 being created. The data that is returned is documented 1453 being created. The data that is returned is documented
1453 in the section titled <a href="#refactorings">Refactorings</a>, la beled as 1454 in the section titled <a href="#refactorings">Refactorings</a>, la beled as
1454 “Feedback”. 1455 “Feedback”.
1455 </p> 1456 </p>
1456 </dd><dt class="field"><b><i>change ( <span style="color:#999999">opti onal</span> <a href="#type_SourceChange">SourceChange</a> )</i></b></dt><dd> 1457 </dd><dt class="field"><b><i>change ( <span style="color:#999999">opti onal</span> <a href="#type_SourceChange">SourceChange</a> )</i></b></dt><dd>
1457 1458
1458 <p> 1459 <p>
1459 The changes that are to be applied to affect the 1460 The changes that are to be applied to affect the
1460 refactoring. This field will be omitted if there are 1461 refactoring. This field will be omitted if there are
1461 problems that prevent a set of changed from being 1462 problems that prevent a set of changes from being
1462 computed, such as having no options specified for a 1463 computed, such as having no options specified for a
1463 refactoring that requires them, or if only validation 1464 refactoring that requires them, or if only validation
1464 was requested. 1465 was requested.
1465 </p> 1466 </p>
1467 </dd><dt class="field"><b><i>potentialChanges ( <span style="color:#99 9999">optional</span> List&lt;String&gt; )</i></b></dt><dd>
1468
1469 <p>
1470 The ids of source edits that are not known to be valid. An edit is
1471 not known to be valid if there was insufficient type information
1472 for the server to be able to determine whether or not the code
1473 needs to be modified, such as when a member is being renamed and
1474 there is a reference to a member from an unknown type. This field
1475 will be omitted if the change field is omitted or if there are no
1476 potential edits for the refactoring.
1477 </p>
1466 </dd></dl></dd></dl> 1478 </dd></dl></dd></dl>
1467 <h2 class="domain"><a name="domain_debug">Domain: debug</a></h2> 1479 <h2 class="domain"><a name="domain_debug">Domain: debug</a></h2>
1468 <p> 1480 <p>
1469 The debugging domain contains commands related to providing a 1481 The debugging domain contains commands related to providing a
1470 debugging experience. 1482 debugging experience.
1471 </p> 1483 </p>
1472 1484
1473 1485
1474 1486
1475 1487
(...skipping 1193 matching lines...) Expand 10 before | Expand all | Expand 10 after
2669 2681
2670 <p> 2682 <p>
2671 The length of the region to be modified. 2683 The length of the region to be modified.
2672 </p> 2684 </p>
2673 </dd><dt class="field"><b><i>replacement ( String )</i></b></dt><dd> 2685 </dd><dt class="field"><b><i>replacement ( String )</i></b></dt><dd>
2674 2686
2675 <p> 2687 <p>
2676 The code that is to replace the specified region in the 2688 The code that is to replace the specified region in the
2677 original code. 2689 original code.
2678 </p> 2690 </p>
2691 </dd><dt class="field"><b><i>id ( <span style="color:#999999">optional </span> String )</i></b></dt><dd>
2692
2693 <p>
2694 An identifier that uniquely identifies this source edit from other
2695 edits in the same response. This field is omitted unless a
2696 containing structure needs to be able to identify the edit for
2697 some reason.
2698 </p>
2699 <p>
2700 For example, some refactoring operations can produce edits that
2701 might not be appropriate (referred to as potential edits). Such
2702 edits will have an id so that they can be referenced. Edits in
2703 the same response that do not need to be referenced will not have
2704 an id.
2705 </p>
2679 </dd></dl></dd><dt class="typeDefinition"><a name="type_SourceFileEdit ">SourceFileEdit: object</a></dt><dd> 2706 </dd></dl></dd><dt class="typeDefinition"><a name="type_SourceFileEdit ">SourceFileEdit: object</a></dt><dd>
2680 <p> 2707 <p>
2681 A description of a set of changes to a single file. 2708 A description of a set of changes to a single file.
2682 </p> 2709 </p>
2683 2710
2684 <dl><dt class="field"><b><i>file ( <a href="#type_FilePath">FilePath</a> ) </i></b></dt><dd> 2711 <dl><dt class="field"><b><i>file ( <a href="#type_FilePath">FilePath</a> ) </i></b></dt><dd>
2685 2712
2686 <p> 2713 <p>
2687 The file containing the code to be modified. 2714 The file containing the code to be modified.
2688 </p> 2715 </p>
(...skipping 320 matching lines...) Expand 10 before | Expand all | Expand 10 after
3009 <p> 3036 <p>
3010 This section contains a list of all of the errors that are 3037 This section contains a list of all of the errors that are
3011 produced by the server and the data that is returned with each. 3038 produced by the server and the data that is returned with each.
3012 </p> 3039 </p>
3013 <p> 3040 <p>
3014 TBD 3041 TBD
3015 </p> 3042 </p>
3016 3043
3017 3044
3018 </body></html> 3045 </body></html>
OLDNEW

Powered by Google App Engine
This is Rietveld 408576698