pkg/analysis_server/doc/api.html - Issue 769963003: Add paging support

Unified Diff: pkg/analysis_server/doc/api.html

Issue 769963003: Add paging support (Closed) Base URL: https://dart.googlecode.com/svn/branches/bleeding_edge/dart

Patch Set: Address comments Created 6 years 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 side-by-side diff with in-line comments

« no previous file with comments | « editor/tools/plugins/com.google.dart.server/src/com/google/dart/server/generated/types/RequestErrorCode.java ('k') | pkg/analysis_server/lib/src/generated_protocol.dart » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Hide Comments ('s')

Index: pkg/analysis_server/doc/api.html

diff --git a/pkg/analysis_server/doc/api.html b/pkg/analysis_server/doc/api.html

index 1fff91581a0d201efdd5ec2fc48c7d3640dad503..3fcc8f6ebc7f6601450978809c61260eb5052043 100644

--- a/pkg/analysis_server/doc/api.html

+++ b/pkg/analysis_server/doc/api.html

@@ -338,6 +338,8 @@ dt.typeDefinition {

<h3>Requests</h3><dl><dt class="request">analysis.getErrors</dt><dd><div class="box"><pre>request: {

"id": String

"method": "analysis.getErrors"

@@ -360,7 +362,9 @@ dt.typeDefinition {

for the file cannot be computed, then the subset of the

errors that can be computed will be returned and the

response will contain an error to indicate why the errors

- could not be computed.

+ could not be computed. If the content of the file changes after this

+ request was received but before a response could be sent, then an

+ error of type <tt>CONTENT_MODIFIED</tt> will be generated.

This request is intended to be used by clients that cannot

@@ -413,14 +417,12 @@ dt.typeDefinition {

<h4>Parameters</h4><dl><dt class="field">file ( <a href="#type_FilePath">FilePath</a> )</dt><dd>

- The file in which hover information is being

- requested.

+ The file in which hover information is being requested.

</dd><dt class="field">offset ( int )</dt><dd>

- The offset for which hover information is being

- requested.

+ The offset for which hover information is being requested.

</dd></dl><h4>Returns</h4><dl><dt class="field">hovers ( List<<a href="#type_HoverInformation">HoverInformation</a>> )</dt><dd>

@@ -432,6 +434,78 @@ dt.typeDefinition {

in multiple contexts in conflicting ways (such as a

part that is included in multiple libraries).

+ </dd></dl></dd><dt class="request">analysis.getNavigation</dt><dd><div class="box"><pre>request: {

+ "id": String

+ "method": "analysis.getNavigation"

+ "params": {

+ "file": <a href="#type_FilePath">FilePath</a>

+ "offset": int

+ "length": int

+ }

+}</pre> <pre>response: {

+ "id": String

+ "error": optional <a href="#type_RequestError">RequestError</a>

+ "result": {

+ "files": List<<a href="#type_FilePath">FilePath</a>>

+ "targets": List<<a href="#type_NavigationTarget">NavigationTarget</a>>

+ "regions": List<<a href="#type_NavigationRegion">NavigationRegion</a>>

+ }

+}</pre></div>

+

+ Return the navigation information associated with the given region of

+ the given file. If the navigation information for the given file has

+ not yet been computed, or the most recently computed navigation

+ information for the given file is out of date, then the response for

+ this request will be delayed until it has been computed. If the

+ content of the file changes after this request was received but before

+ a response could be sent, then an error of type

+ <tt>CONTENT_MODIFIED</tt> will be generated.

+

+

+ If a navigation region overlaps (but extends either before or after)

+ the given region of the file it will be included in the result. This

+ means that it is theoretically possible to get the same navigation

+ region in response to multiple requests. Clients can avoid this by

+ always choosing a region that starts at the beginning of a line and

+ ends at the end of a (possibly different) line in the file.

+

+ <h4>Parameters</h4><dl><dt class="field">file ( <a href="#type_FilePath">FilePath</a> )</dt><dd>

+

+ The file in which navigation information is being requested.

+

+ </dd><dt class="field">offset ( int )</dt><dd>

+

+ The offset of the region for which navigation information is being

+ requested.

+

+ </dd><dt class="field">length ( int )</dt><dd>

+

+ The length of the region for which navigation information is being

+ requested.

+

+ </dd></dl><h4>Returns</h4><dl><dt class="field">files ( List<<a href="#type_FilePath">FilePath</a>> )</dt><dd>

+

+ A list of the paths of files that are referenced by the navigation

+ targets.

+

+ </dd><dt class="field">targets ( List<<a href="#type_NavigationTarget">NavigationTarget</a>> )</dt><dd>

+

+ A list of the navigation targets that are referenced by the

+ navigation regions.

+

+ </dd><dt class="field">regions ( List<<a href="#type_NavigationRegion">NavigationRegion</a>> )</dt><dd>

+

+ A list of the navigation regions within the requested region of

+ the file.

+

</dd></dl></dd><dt class="request">analysis.reanalyze</dt><dd><div class="box"><pre>request: {

"id": String

"method": "analysis.reanalyze"

@@ -779,6 +853,47 @@ dt.typeDefinition {

other highlight regions if there is more than one

meaning associated with a particular region.

+ </dd></dl></dd><dt class="notification">analysis.invalidate</dt><dd><div class="box"><pre>notification: {

+ "event": "analysis.invalidate"

+ "params": {

+ "file": <a href="#type_FilePath">FilePath</a>

+ "offset": int

+ "length": int

+ "delta": int

+ }

+}</pre></div>

+

+ Reports that the navigation information associated with a region of a

+ single file has become invalid and should be re-requested.

+

+

+ This notification is not subscribed to by default. Clients can

+ subscribe by including the value <tt>"INVALIDATE"</tt> in the list of

+ services passed in an analysis.setSubscriptions request.

+

+ <h4>Parameters</h4><dl><dt class="field">file ( <a href="#type_FilePath">FilePath</a> )</dt><dd>

+

+ The file whose information has been invalidated.

+

+ </dd><dt class="field">offset ( int )</dt><dd>

+

+ The offset of the invalidated region.

+

+ </dd><dt class="field">length ( int )</dt><dd>

+

+ The length of the invalidated region.

+

+ </dd><dt class="field">delta ( int )</dt><dd>

+

+ The delta to be applied to the offsets in information that follows

+ the invalidated region in order to update it so that it doesn't

+ need to be re-requested.

+

</dd></dl></dd><dt class="notification">analysis.navigation</dt><dd><div class="box"><pre>notification: {

"event": "analysis.navigation"

"params": {

@@ -1941,7 +2056,7 @@ dt.typeDefinition {

domain.

- <dl><dt class="value">FOLDING</dt><dt class="value">HIGHLIGHTS</dt><dt class="value">NAVIGATION</dt><dt class="value">OCCURRENCES</dt><dt class="value">OUTLINE</dt><dt class="value">OVERRIDES</dt></dl></dd><dt class="typeDefinition"><a name="type_AnalysisStatus">AnalysisStatus: object</a></dt><dd>

+ <dl><dt class="value">FOLDING</dt><dt class="value">HIGHLIGHTS</dt><dt class="value">INVALIDATE</dt><dt class="value">NAVIGATION</dt><dt class="value">OCCURRENCES</dt><dt class="value">OUTLINE</dt><dt class="value">OVERRIDES</dt></dl></dd><dt class="typeDefinition"><a name="type_AnalysisStatus">AnalysisStatus: object</a></dt><dd>

An indication of the current state of analysis.

@@ -2762,7 +2877,14 @@ dt.typeDefinition {

execution of the server.

- <dl><dt class="value">GET_ERRORS_INVALID_FILE</dt><dd>

+ <dl><dt class="value">CONTENT_MODIFIED</dt><dd>

+

+ An "analysis.getErrors" or "analysis.getNavigation" request could

+ not be satisfied because the content of the file changed before

+ the requested results could be computed.

+

+ </dd><dt class="value">GET_ERRORS_INVALID_FILE</dt><dd>

An "analysis.getErrors" request specified a FilePath