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

Issues Search
    My Issues | Starred     Open | Closed | All

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

Issue 2922603002: Add an analytics domain to the analysis server. (Closed)
Patch Set: review comments Created 3 years, 6 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
« no previous file with comments | « no previous file | pkg/analysis_server/lib/protocol/protocol_generated.dart » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
1 <!DOCTYPE html><html><head> 1 <!DOCTYPE html><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 <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Source+Code +Pro|Roboto:500,400italic,300,400" type="text/css"><style>body { 4 <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Source+Code +Pro|Roboto:500,400italic,300,400" type="text/css"><style>body {
5 font-family: 'Roboto', sans-serif; 5 font-family: 'Roboto', sans-serif;
6 max-width: 800px; 6 max-width: 800px;
7 margin: 0 auto; 7 margin: 0 auto;
8 padding: 0 16px; 8 padding: 0 16px;
9 font-size: 16px; 9 font-size: 16px;
10 line-height: 1.5; 10 line-height: 1.5;
(...skipping 2474 matching lines...) Expand 10 before | Expand all | Expand 10 after
2485 this call will start the server. If unable to start the diagnostic web 2485 this call will start the server. If unable to start the diagnostic web
2486 server, 2486 server,
2487 this call will return an error of <tt>DEBUG_PORT_COULD_NOT_BE_OPENED</tt>. 2487 this call will return an error of <tt>DEBUG_PORT_COULD_NOT_BE_OPENED</tt>.
2488 </p> 2488 </p>
2489 2489
2490 <h4>returns:</h4><dl><dt class="field"><b>port: int</b></dt><dd> 2490 <h4>returns:</h4><dl><dt class="field"><b>port: int</b></dt><dd>
2491 2491
2492 <p>The diagnostic server port.</p> 2492 <p>The diagnostic server port.</p>
2493 </dd></dl></dd></dl> 2493 </dd></dl></dd></dl>
2494 2494
2495
2495 <h2 class="domain"><a name="types">Types</a></h2> 2496 <h2 class="domain"><a name="types">Types</a></h2>
2496 <p> 2497 <p>
2497 This section contains descriptions of the data types referenced 2498 This section contains descriptions of the data types referenced
2498 in the API’s of the various domains. 2499 in the API’s of the various domains.
2499 </p> 2500 </p>
2500 2501
2501 2502
2502 2503
2503 2504
2504 2505
(...skipping 2049 matching lines...) Expand 10 before | Expand all | Expand 10 after
4554 produced by the server and the data that is returned with each. 4555 produced by the server and the data that is returned with each.
4555 </p> 4556 </p>
4556 <p> 4557 <p>
4557 TODO: TBD 4558 TODO: TBD
4558 </p> 4559 </p>
4559 <h2 class="domain"><a name="index">Index</a></h2> 4560 <h2 class="domain"><a name="index">Index</a></h2>
4560 <h3>Domains</h3><h4>server (<a href="#domain_server">↑</a>)</h4><div class="subi ndex"><h5>Requests</h5><ul><li><a href="#request_server.getVersion">getVersion</ a></li><li><a href="#request_server.shutdown">shutdown</a></li><li><a href="#req uest_server.setSubscriptions">setSubscriptions</a></li></ul><h5>Notifications</h 5><div class="subindex"><ul><li><a href="#notification_server.connected">connect ed</a></li><li><a href="#notification_server.error">error</a></li><li><a href="# notification_server.status">status</a></li></ul></div></div><h4>analysis (<a hre f="#domain_analysis">↑</a>)</h4><div class="subindex"><h5>Requests</h5><ul><li>< a href="#request_analysis.getErrors">getErrors</a></li><li><a href="#request_ana lysis.getHover">getHover</a></li><li><a href="#request_analysis.getReachableSour ces">getReachableSources</a></li><li><a href="#request_analysis.getLibraryDepend encies">getLibraryDependencies</a></li><li><a href="#request_analysis.getNavigat ion">getNavigation</a></li><li><a href="#request_analysis.reanalyze">reanalyze</ a></li><li><a href="#request_analysis.setAnalysisRoots">setAnalysisRoots</a></li ><li><a href="#request_analysis.setGeneralSubscriptions">setGeneralSubscriptions </a></li><li><a href="#request_analysis.setPriorityFiles">setPriorityFiles</a></ li><li><a href="#request_analysis.setSubscriptions">setSubscriptions</a></li><li ><a href="#request_analysis.updateContent">updateContent</a></li><li><a href="#r equest_analysis.updateOptions">updateOptions</a></li></ul><h5>Notifications</h5> <div class="subindex"><ul><li><a href="#notification_analysis.analyzedFiles">ana lyzedFiles</a></li><li><a href="#notification_analysis.errors">errors</a></li><l i><a href="#notification_analysis.flushResults">flushResults</a></li><li><a href ="#notification_analysis.folding">folding</a></li><li><a href="#notification_ana lysis.highlights">highlights</a></li><li><a href="#notification_analysis.impleme nted">implemented</a></li><li><a href="#notification_analysis.invalidate">invali date</a></li><li><a href="#notification_analysis.navigation">navigation</a></li> <li><a href="#notification_analysis.occurrences">occurrences</a></li><li><a href ="#notification_analysis.outline">outline</a></li><li><a href="#notification_ana lysis.overrides">overrides</a></li></ul></div></div><h4>completion (<a href="#do main_completion">↑</a>)</h4><div class="subindex"><h5>Requests</h5><ul><li><a hr ef="#request_completion.getSuggestions">getSuggestions</a></li></ul><h5>Notifica tions</h5><div class="subindex"><ul><li><a href="#notification_completion.result s">results</a></li></ul></div></div><h4>search (<a href="#domain_search">↑</a>)< /h4><div class="subindex"><h5>Requests</h5><ul><li><a href="#request_search.find ElementReferences">findElementReferences</a></li><li><a href="#request_search.fi ndMemberDeclarations">findMemberDeclarations</a></li><li><a href="#request_searc h.findMemberReferences">findMemberReferences</a></li><li><a href="#request_searc h.findTopLevelDeclarations">findTopLevelDeclarations</a></li><li><a href="#reque st_search.getTypeHierarchy">getTypeHierarchy</a></li></ul><h5>Notifications</h5> <div class="subindex"><ul><li><a href="#notification_search.results">results</a> </li></ul></div></div><h4>edit (<a href="#domain_edit">↑</a>)</h4><div class="su bindex"><h5>Requests</h5><ul><li><a href="#request_edit.format">format</a></li>< li><a href="#request_edit.getAssists">getAssists</a></li><li><a href="#request_e dit.getAvailableRefactorings">getAvailableRefactorings</a></li><li><a href="#req uest_edit.getFixes">getFixes</a></li><li><a href="#request_edit.getRefactoring"> getRefactoring</a></li><li><a href="#request_edit.sortMembers">sortMembers</a></ li><li><a href="#request_edit.organizeDirectives">organizeDirectives</a></li></u l></div><h4>execution (<a href="#domain_execution">↑</a>)</h4><div class="subind ex"><h5>Requests</h5><ul><li><a href="#request_execution.createContext">createCo ntext</a></li><li><a href="#request_execution.deleteContext">deleteContext</a></ li><li><a href="#request_execution.mapUri">mapUri</a></li><li><a href="#request_ execution.setSubscriptions">setSubscriptions</a></li></ul><h5>Notifications</h5> <div class="subindex"><ul><li><a href="#notification_execution.launchData">launc hData</a></li></ul></div></div><h4>diagnostic (<a href="#domain_diagnostic">↑</a >)</h4><div class="subindex"><h5>Requests</h5><ul><li><a href="#request_diagnost ic.getDiagnostics">getDiagnostics</a></li><li><a href="#request_diagnostic.getSe rverPort">getServerPort</a></li></ul></div><h3>Types (<a href="#types">↑</a>)</h 3><div class="subindex"><ul><li><a href="#type_AddContentOverlay">AddContentOver lay</a></li><li><a href="#type_AnalysisError">AnalysisError</a></li><li><a href= "#type_AnalysisErrorFixes">AnalysisErrorFixes</a></li><li><a href="#type_Analysi sErrorSeverity">AnalysisErrorSeverity</a></li><li><a href="#type_AnalysisErrorTy pe">AnalysisErrorType</a></li><li><a href="#type_AnalysisOptions">AnalysisOption s</a></li><li><a href="#type_AnalysisService">AnalysisService</a></li><li><a hre f="#type_AnalysisStatus">AnalysisStatus</a></li><li><a href="#type_ChangeContent Overlay">ChangeContentOverlay</a></li><li><a href="#type_CompletionId">Completio nId</a></li><li><a href="#type_CompletionSuggestion">CompletionSuggestion</a></l i><li><a href="#type_CompletionSuggestionKind">CompletionSuggestionKind</a></li> <li><a href="#type_ContextData">ContextData</a></li><li><a href="#type_Element"> Element</a></li><li><a href="#type_ElementKind">ElementKind</a></li><li><a href= "#type_ExecutableFile">ExecutableFile</a></li><li><a href="#type_ExecutableKind" >ExecutableKind</a></li><li><a href="#type_ExecutionContextId">ExecutionContextI d</a></li><li><a href="#type_ExecutionService">ExecutionService</a></li><li><a h ref="#type_FileKind">FileKind</a></li><li><a href="#type_FilePath">FilePath</a>< /li><li><a href="#type_FoldingKind">FoldingKind</a></li><li><a href="#type_Foldi ngRegion">FoldingRegion</a></li><li><a href="#type_GeneralAnalysisService">Gener alAnalysisService</a></li><li><a href="#type_HighlightRegion">HighlightRegion</a ></li><li><a href="#type_HighlightRegionType">HighlightRegionType</a></li><li><a href="#type_HoverInformation">HoverInformation</a></li><li><a href="#type_Imple mentedClass">ImplementedClass</a></li><li><a href="#type_ImplementedMember">Impl ementedMember</a></li><li><a href="#type_LinkedEditGroup">LinkedEditGroup</a></l i><li><a href="#type_LinkedEditSuggestion">LinkedEditSuggestion</a></li><li><a h ref="#type_LinkedEditSuggestionKind">LinkedEditSuggestionKind</a></li><li><a hre f="#type_Location">Location</a></li><li><a href="#type_NavigationRegion">Navigat ionRegion</a></li><li><a href="#type_NavigationTarget">NavigationTarget</a></li> <li><a href="#type_Occurrences">Occurrences</a></li><li><a href="#type_Outline"> Outline</a></li><li><a href="#type_OverriddenMember">OverriddenMember</a></li><l i><a href="#type_Override">Override</a></li><li><a href="#type_Position">Positio n</a></li><li><a href="#type_PubStatus">PubStatus</a></li><li><a href="#type_Ref actoringFeedback">RefactoringFeedback</a></li><li><a href="#type_RefactoringKind ">RefactoringKind</a></li><li><a href="#type_RefactoringMethodParameter">Refacto ringMethodParameter</a></li><li><a href="#type_RefactoringMethodParameterKind">R efactoringMethodParameterKind</a></li><li><a href="#type_RefactoringOptions">Ref actoringOptions</a></li><li><a href="#type_RefactoringProblem">RefactoringProble m</a></li><li><a href="#type_RefactoringProblemSeverity">RefactoringProblemSever ity</a></li><li><a href="#type_RemoveContentOverlay">RemoveContentOverlay</a></l i><li><a href="#type_RequestError">RequestError</a></li><li><a href="#type_Reque stErrorCode">RequestErrorCode</a></li><li><a href="#type_SearchId">SearchId</a>< /li><li><a href="#type_SearchResult">SearchResult</a></li><li><a href="#type_Sea rchResultKind">SearchResultKind</a></li><li><a href="#type_ServerService">Server Service</a></li><li><a href="#type_SourceChange">SourceChange</a></li><li><a hre f="#type_SourceEdit">SourceEdit</a></li><li><a href="#type_SourceFileEdit">Sourc eFileEdit</a></li><li><a href="#type_TypeHierarchyItem">TypeHierarchyItem</a></l i></ul></div><h3>Refactorings (<a href="#refactorings">↑</a>)</h3><div class="su bindex"><ul><li><a href="#refactoring_CONVERT_GETTER_TO_METHOD">CONVERT_GETTER_T O_METHOD</a></li><li><a href="#refactoring_CONVERT_METHOD_TO_GETTER">CONVERT_MET HOD_TO_GETTER</a></li><li><a href="#refactoring_EXTRACT_LOCAL_VARIABLE">EXTRACT_ LOCAL_VARIABLE</a></li><li><a href="#refactoring_EXTRACT_METHOD">EXTRACT_METHOD< /a></li><li><a href="#refactoring_INLINE_LOCAL_VARIABLE">INLINE_LOCAL_VARIABLE</ a></li><li><a href="#refactoring_INLINE_METHOD">INLINE_METHOD</a></li><li><a hre f="#refactoring_MOVE_FILE">MOVE_FILE</a></li><li><a href="#refactoring_RENAME">R ENAME</a></li></ul></div> 4561 <h3>Domains</h3><h4>server (<a href="#domain_server">↑</a>)</h4><div class="subi ndex"><h5>Requests</h5><ul><li><a href="#request_server.getVersion">getVersion</ a></li><li><a href="#request_server.shutdown">shutdown</a></li><li><a href="#req uest_server.setSubscriptions">setSubscriptions</a></li></ul><h5>Notifications</h 5><div class="subindex"><ul><li><a href="#notification_server.connected">connect ed</a></li><li><a href="#notification_server.error">error</a></li><li><a href="# notification_server.status">status</a></li></ul></div></div><h4>analysis (<a hre f="#domain_analysis">↑</a>)</h4><div class="subindex"><h5>Requests</h5><ul><li>< a href="#request_analysis.getErrors">getErrors</a></li><li><a href="#request_ana lysis.getHover">getHover</a></li><li><a href="#request_analysis.getReachableSour ces">getReachableSources</a></li><li><a href="#request_analysis.getLibraryDepend encies">getLibraryDependencies</a></li><li><a href="#request_analysis.getNavigat ion">getNavigation</a></li><li><a href="#request_analysis.reanalyze">reanalyze</ a></li><li><a href="#request_analysis.setAnalysisRoots">setAnalysisRoots</a></li ><li><a href="#request_analysis.setGeneralSubscriptions">setGeneralSubscriptions </a></li><li><a href="#request_analysis.setPriorityFiles">setPriorityFiles</a></ li><li><a href="#request_analysis.setSubscriptions">setSubscriptions</a></li><li ><a href="#request_analysis.updateContent">updateContent</a></li><li><a href="#r equest_analysis.updateOptions">updateOptions</a></li></ul><h5>Notifications</h5> <div class="subindex"><ul><li><a href="#notification_analysis.analyzedFiles">ana lyzedFiles</a></li><li><a href="#notification_analysis.errors">errors</a></li><l i><a href="#notification_analysis.flushResults">flushResults</a></li><li><a href ="#notification_analysis.folding">folding</a></li><li><a href="#notification_ana lysis.highlights">highlights</a></li><li><a href="#notification_analysis.impleme nted">implemented</a></li><li><a href="#notification_analysis.invalidate">invali date</a></li><li><a href="#notification_analysis.navigation">navigation</a></li> <li><a href="#notification_analysis.occurrences">occurrences</a></li><li><a href ="#notification_analysis.outline">outline</a></li><li><a href="#notification_ana lysis.overrides">overrides</a></li></ul></div></div><h4>completion (<a href="#do main_completion">↑</a>)</h4><div class="subindex"><h5>Requests</h5><ul><li><a hr ef="#request_completion.getSuggestions">getSuggestions</a></li></ul><h5>Notifica tions</h5><div class="subindex"><ul><li><a href="#notification_completion.result s">results</a></li></ul></div></div><h4>search (<a href="#domain_search">↑</a>)< /h4><div class="subindex"><h5>Requests</h5><ul><li><a href="#request_search.find ElementReferences">findElementReferences</a></li><li><a href="#request_search.fi ndMemberDeclarations">findMemberDeclarations</a></li><li><a href="#request_searc h.findMemberReferences">findMemberReferences</a></li><li><a href="#request_searc h.findTopLevelDeclarations">findTopLevelDeclarations</a></li><li><a href="#reque st_search.getTypeHierarchy">getTypeHierarchy</a></li></ul><h5>Notifications</h5> <div class="subindex"><ul><li><a href="#notification_search.results">results</a> </li></ul></div></div><h4>edit (<a href="#domain_edit">↑</a>)</h4><div class="su bindex"><h5>Requests</h5><ul><li><a href="#request_edit.format">format</a></li>< li><a href="#request_edit.getAssists">getAssists</a></li><li><a href="#request_e dit.getAvailableRefactorings">getAvailableRefactorings</a></li><li><a href="#req uest_edit.getFixes">getFixes</a></li><li><a href="#request_edit.getRefactoring"> getRefactoring</a></li><li><a href="#request_edit.sortMembers">sortMembers</a></ li><li><a href="#request_edit.organizeDirectives">organizeDirectives</a></li></u l></div><h4>execution (<a href="#domain_execution">↑</a>)</h4><div class="subind ex"><h5>Requests</h5><ul><li><a href="#request_execution.createContext">createCo ntext</a></li><li><a href="#request_execution.deleteContext">deleteContext</a></ li><li><a href="#request_execution.mapUri">mapUri</a></li><li><a href="#request_ execution.setSubscriptions">setSubscriptions</a></li></ul><h5>Notifications</h5> <div class="subindex"><ul><li><a href="#notification_execution.launchData">launc hData</a></li></ul></div></div><h4>diagnostic (<a href="#domain_diagnostic">↑</a >)</h4><div class="subindex"><h5>Requests</h5><ul><li><a href="#request_diagnost ic.getDiagnostics">getDiagnostics</a></li><li><a href="#request_diagnostic.getSe rverPort">getServerPort</a></li></ul></div><h3>Types (<a href="#types">↑</a>)</h 3><div class="subindex"><ul><li><a href="#type_AddContentOverlay">AddContentOver lay</a></li><li><a href="#type_AnalysisError">AnalysisError</a></li><li><a href= "#type_AnalysisErrorFixes">AnalysisErrorFixes</a></li><li><a href="#type_Analysi sErrorSeverity">AnalysisErrorSeverity</a></li><li><a href="#type_AnalysisErrorTy pe">AnalysisErrorType</a></li><li><a href="#type_AnalysisOptions">AnalysisOption s</a></li><li><a href="#type_AnalysisService">AnalysisService</a></li><li><a hre f="#type_AnalysisStatus">AnalysisStatus</a></li><li><a href="#type_ChangeContent Overlay">ChangeContentOverlay</a></li><li><a href="#type_CompletionId">Completio nId</a></li><li><a href="#type_CompletionSuggestion">CompletionSuggestion</a></l i><li><a href="#type_CompletionSuggestionKind">CompletionSuggestionKind</a></li> <li><a href="#type_ContextData">ContextData</a></li><li><a href="#type_Element"> Element</a></li><li><a href="#type_ElementKind">ElementKind</a></li><li><a href= "#type_ExecutableFile">ExecutableFile</a></li><li><a href="#type_ExecutableKind" >ExecutableKind</a></li><li><a href="#type_ExecutionContextId">ExecutionContextI d</a></li><li><a href="#type_ExecutionService">ExecutionService</a></li><li><a h ref="#type_FileKind">FileKind</a></li><li><a href="#type_FilePath">FilePath</a>< /li><li><a href="#type_FoldingKind">FoldingKind</a></li><li><a href="#type_Foldi ngRegion">FoldingRegion</a></li><li><a href="#type_GeneralAnalysisService">Gener alAnalysisService</a></li><li><a href="#type_HighlightRegion">HighlightRegion</a ></li><li><a href="#type_HighlightRegionType">HighlightRegionType</a></li><li><a href="#type_HoverInformation">HoverInformation</a></li><li><a href="#type_Imple mentedClass">ImplementedClass</a></li><li><a href="#type_ImplementedMember">Impl ementedMember</a></li><li><a href="#type_LinkedEditGroup">LinkedEditGroup</a></l i><li><a href="#type_LinkedEditSuggestion">LinkedEditSuggestion</a></li><li><a h ref="#type_LinkedEditSuggestionKind">LinkedEditSuggestionKind</a></li><li><a hre f="#type_Location">Location</a></li><li><a href="#type_NavigationRegion">Navigat ionRegion</a></li><li><a href="#type_NavigationTarget">NavigationTarget</a></li> <li><a href="#type_Occurrences">Occurrences</a></li><li><a href="#type_Outline"> Outline</a></li><li><a href="#type_OverriddenMember">OverriddenMember</a></li><l i><a href="#type_Override">Override</a></li><li><a href="#type_Position">Positio n</a></li><li><a href="#type_PubStatus">PubStatus</a></li><li><a href="#type_Ref actoringFeedback">RefactoringFeedback</a></li><li><a href="#type_RefactoringKind ">RefactoringKind</a></li><li><a href="#type_RefactoringMethodParameter">Refacto ringMethodParameter</a></li><li><a href="#type_RefactoringMethodParameterKind">R efactoringMethodParameterKind</a></li><li><a href="#type_RefactoringOptions">Ref actoringOptions</a></li><li><a href="#type_RefactoringProblem">RefactoringProble m</a></li><li><a href="#type_RefactoringProblemSeverity">RefactoringProblemSever ity</a></li><li><a href="#type_RemoveContentOverlay">RemoveContentOverlay</a></l i><li><a href="#type_RequestError">RequestError</a></li><li><a href="#type_Reque stErrorCode">RequestErrorCode</a></li><li><a href="#type_SearchId">SearchId</a>< /li><li><a href="#type_SearchResult">SearchResult</a></li><li><a href="#type_Sea rchResultKind">SearchResultKind</a></li><li><a href="#type_ServerService">Server Service</a></li><li><a href="#type_SourceChange">SourceChange</a></li><li><a hre f="#type_SourceEdit">SourceEdit</a></li><li><a href="#type_SourceFileEdit">Sourc eFileEdit</a></li><li><a href="#type_TypeHierarchyItem">TypeHierarchyItem</a></l i></ul></div><h3>Refactorings (<a href="#refactorings">↑</a>)</h3><div class="su bindex"><ul><li><a href="#refactoring_CONVERT_GETTER_TO_METHOD">CONVERT_GETTER_T O_METHOD</a></li><li><a href="#refactoring_CONVERT_METHOD_TO_GETTER">CONVERT_MET HOD_TO_GETTER</a></li><li><a href="#refactoring_EXTRACT_LOCAL_VARIABLE">EXTRACT_ LOCAL_VARIABLE</a></li><li><a href="#refactoring_EXTRACT_METHOD">EXTRACT_METHOD< /a></li><li><a href="#refactoring_INLINE_LOCAL_VARIABLE">INLINE_LOCAL_VARIABLE</ a></li><li><a href="#refactoring_INLINE_METHOD">INLINE_METHOD</a></li><li><a hre f="#refactoring_MOVE_FILE">MOVE_FILE</a></li><li><a href="#refactoring_RENAME">R ENAME</a></li></ul></div>
4561 4562
4562 4563
4563 </body></html> 4564 </body></html>
OLDNEW
« no previous file with comments | « no previous file | pkg/analysis_server/lib/protocol/protocol_generated.dart » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698