pkg/analysis_server/tool/spec/spec_input.html - Issue 1491013002: Analysis request `getReachableSources` (#24893).

Keyboard Shortcuts

	File
u :	up to issue
j / k :	jump to file after / before current file
J / K :	jump to next file with a comment after / before current file
	Side-by-side diff
i :	toggle intra-line diffs
e :	expand all comments
c :	collapse all comments
s :	toggle showing all comments
n / p :	next / previous diff chunk or comment
N / P :	next / previous comment
<Up> / <Down> :	next / previous line

	Issue
u :	up to list of issues
j / k :	jump to patch after / before current patch
o / <Enter> :	open current patch in side-by-side view
i :	open current patch in unified diff view

	Issue List
j / k :	jump to issue after / before current issue
o / <Enter> :	open current issue

Unified Diff: pkg/analysis_server/tool/spec/spec_input.html

Issue 1491013002: Analysis request `getReachableSources` (#24893). (Closed) Base URL: git@github.com:dart-lang/sdk.git@master

Patch Set: spec_bump Created 5 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

Download patch

Index: pkg/analysis_server/tool/spec/spec_input.html

diff --git a/pkg/analysis_server/tool/spec/spec_input.html b/pkg/analysis_server/tool/spec/spec_input.html

index c0697a52bc46383fb486ad7d496d43a98fd8811b..fcddc9407a1b37786e4223b347ccd1833ab5d284 100644

--- a/pkg/analysis_server/tool/spec/spec_input.html

+++ b/pkg/analysis_server/tool/spec/spec_input.html

@@ -6,7 +6,7 @@

</head>

<body>

<h1>Analysis Server API Specification</h1>

- <h1 style="color:#999999">Version <version>1.12.0</version></h1>

+ <h1 style="color:#999999">Version <version>1.13.0</version></h1>

<p>

This document contains a specification of the API provided by the

analysis server. The API in this document is currently under

@@ -395,6 +395,42 @@

</field>

</result>

</request>

+ <request method="getReachableSources">

+ <p>

+ Return the transitive closure of reachable sources for a given file.

+ </p>

+ <p>

+ If a request is made for a file which does not exist, or

+ which is not currently subject to analysis (e.g. because it

+ is not associated with any analysis root specified to

+ analysis.setAnalysisRoots), an error of type

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

+ </p>

+ <params>

+ <field name="file">

+ <ref>FilePath</ref>

+ <p>

+ The file for which reachable source information is being requested.

+ </p>

+ </field>

+ </params>

+ <result>

+ <field name="sources">

+ <map>

+ <key><ref>String</ref></key>

+ <value><list>><ref>String</ref></list></value>

+ </map>

+ <p>

+ A mapping from source URIs to directly reachable source URIs. For example,

+ a file "foo.dart" that imports "bar.dart" would have the corresponding mapping

+ { "file:///foo.dart" : ["file:///bar.dart"] }. If "bar.dart" has further imports

+ (or exports) there will be a mapping from the URI "file:///bar.dart" to them.

+ To check if a specific URI is reachable from a given file, clients can check

+ for its presence in the resulting key set.

+ </p>

+ </field>

+ </result>

+ </request>

<p>

Return library dependency information for use in client-side indexing

@@ -3650,6 +3686,14 @@

</p>

</value>

<value>

+ <code>GET_REACHABLE_SOURCES_INVALID_FILE</code>

+ <p>

+ An "analysis.getReachableSources" request specified a FilePath

+ which does not match a file currently subject to

+ analysis.

+ </p>

+ </value>

+ <value>

<code>INVALID_ANALYSIS_ROOT</code>

<p>

A path passed as an argument to a request (such as

« no previous file with comments | « pkg/analysis_server/tool/spec/generated/java/types/RequestErrorCode.java ('k') | no next file » | no next file with comments »