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

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

Issue 943723002: Return version with connected notification (Closed) Base URL: https://dart.googlecode.com/svn/branches/bleeding_edge/dart
Patch Set: Touched missed Java files Created 5 years, 10 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 side-by-side diff with in-line comments
Download patch
Index: pkg/analysis_server/doc/api.html
diff --git a/pkg/analysis_server/doc/api.html b/pkg/analysis_server/doc/api.html
index 6d97d81d1af0d2964eb5cda76d436082c9ffe98a..9656d5c6d60116478e4c5d65839e1f38f935d85f 100644
--- a/pkg/analysis_server/doc/api.html
+++ b/pkg/analysis_server/doc/api.html
@@ -43,7 +43,7 @@ dt.typeDefinition {
</style></head>
<body>
<h1>Analysis Server API Specification</h1>
- <h1 style="color:#999999">Version 1.2.0</h1>
+ <h1 style="color:#999999">Version 1.3.0</h1>
<p>
This document contains a specification of the API provided by the
analysis server. The API in this document is currently under
@@ -147,6 +147,12 @@ dt.typeDefinition {
kind of notification being sent. The structure of this field is
described with each notification.
</p>
+ <p>
+ In order to be backward compatible, clients should ignore fields that were
+ not specified in the version of the API on which they were based. Clients
+ should also use the server.getVersion request to test that the version of
+ the server supports an API before using it.
+ </p>
<h3>Eventual Consistency</h3>
<p>
TBD
@@ -276,6 +282,9 @@ dt.typeDefinition {
<p>A list of the services being subscribed to.</p>
</dd></dl></dd></dl><h3>Notifications</h3><dl><dt class="notification">server.connected</dt><dd><div class="box"><pre>notification: {
"event": "server.connected"
+ "params": {
+ "<b>version</b>": String
+ }
}</pre></div>
<p>
Reports that the server is running. This notification is
@@ -287,7 +296,11 @@ dt.typeDefinition {
It is not possible to subscribe to or unsubscribe from this
notification.
</p>
- </dd><dt class="notification">server.error</dt><dd><div class="box"><pre>notification: {
+
+ <h4>Parameters</h4><dl><dt class="field"><b><i>version ( String )</i></b></dt><dd>
+
+ <p>The version number of the analysis server.</p>
+ </dd></dl></dd><dt class="notification">server.error</dt><dd><div class="box"><pre>notification: {
"event": "server.error"
"params": {
"<b>isFatal</b>": bool

Powered by Google App Engine
This is Rietveld 408576698