openapi: adding watch parameter on list operations

Related to kubevirt#582
guangxuli · Nov 27, 2017 · 1fb460e · 1fb460e
1 parent da9b3ff
commit 1fb460e
Show file tree

Hide file tree

Showing 3 changed files with 51 additions and 10 deletions.
diff --git a/api/openapi-spec/swagger.json b/api/openapi-spec/swagger.json
@@ -151,7 +151,8 @@
      "description": "Get a list of Migration objects.",
      "produces": [
       "application/json",
-      "application/yaml"
+      "application/yaml",
+      "application/json;stream=watch"
      ],
      "summary": "Get a list of Migration objects.",
      "operationId": "listNamespacedMigration",
@@ -175,6 +176,12 @@
        "description": "Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'",
        "name": "exact",
        "in": "query"
+      },
+      {
+       "type": "boolean",
+       "description": "Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.",
+       "name": "watch",
+       "in": "query"
       }
      ],
      "responses": {
@@ -315,6 +322,12 @@
        "description": "Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'",
        "name": "exact",
        "in": "query"
+      },
+      {
+       "type": "boolean",
+       "description": "Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.",
+       "name": "watch",
+       "in": "query"
       }
      ],
      "responses": {
@@ -470,7 +483,8 @@
      "description": "Get a list of VirtualMachineReplicaSet objects.",
      "produces": [
       "application/json",
-      "application/yaml"
+      "application/yaml",
+      "application/json;stream=watch"
      ],
      "summary": "Get a list of VirtualMachineReplicaSet objects.",
      "operationId": "listNamespacedVirtualMachineReplicaSet",
@@ -494,6 +508,12 @@
        "description": "Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'",
        "name": "exact",
        "in": "query"
+      },
+      {
+       "type": "boolean",
+       "description": "Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.",
+       "name": "watch",
+       "in": "query"
       }
      ],
      "responses": {
@@ -634,6 +654,12 @@
        "description": "Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'",
        "name": "exact",
        "in": "query"
+      },
+      {
+       "type": "boolean",
+       "description": "Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.",
+       "name": "watch",
+       "in": "query"
       }
      ],
      "responses": {
@@ -789,7 +815,8 @@
      "description": "Get a list of VirtualMachine objects.",
      "produces": [
       "application/json",
-      "application/yaml"
+      "application/yaml",
+      "application/json;stream=watch"
      ],
      "summary": "Get a list of VirtualMachine objects.",
      "operationId": "listNamespacedVirtualMachine",
@@ -813,6 +840,12 @@
        "description": "Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'",
        "name": "exact",
        "in": "query"
+      },
+      {
+       "type": "boolean",
+       "description": "Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.",
+       "name": "watch",
+       "in": "query"
       }
      ],
      "responses": {
@@ -953,6 +986,12 @@
        "description": "Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'",
        "name": "exact",
        "in": "query"
+      },
+      {
+       "type": "boolean",
+       "description": "Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.",
+       "name": "watch",
+       "in": "query"
       }
      ],
      "responses": {

diff --git a/pkg/rest/mime.go b/pkg/rest/mime.go
@@ -20,9 +20,10 @@
 package rest
 
 const (
-	MIME_JSON       string = "application/json"
-	MIME_JSON_PATCH string = "application/json-patch+json"
-	MIME_YAML       string = "application/yaml"
-	MIME_TEXT       string = "text/plain"
-	MIME_INI        string = "text/plain"
+	MIME_JSON        string = "application/json"
+	MIME_JSON_PATCH  string = "application/json-patch+json"
+	MIME_JSON_STREAM string = "application/json;stream=watch"
+	MIME_YAML        string = "application/yaml"
+	MIME_TEXT        string = "text/plain"
+	MIME_INI         string = "text/plain"
 )
diff --git a/pkg/virt-api/rest/kubeproxy.go b/pkg/virt-api/rest/kubeproxy.go
@@ -175,7 +175,7 @@ func GenericResourceProxy(ws *restful.WebService, ctx context.Context, gvr schem
 
 	ws.Route(addGetNamespacedListParams(
 		ws.GET(ResourceBasePath(gvr)).
-			Produces(mime.MIME_JSON, mime.MIME_YAML).
+			Produces(mime.MIME_JSON, mime.MIME_YAML, mime.MIME_JSON_STREAM).
 			Operation("listNamespaced"+objKind).
 			Writes(listExample).
 			To(endpoints.MakeGoRestfulWrapper(getList)).
@@ -241,7 +241,8 @@ func addGetParams(builder *restful.RouteBuilder, ws *restful.WebService) *restfu
 func addGetNamespacedListParams(builder *restful.RouteBuilder, ws *restful.WebService) *restful.RouteBuilder {
 	return builder.Param(NamespaceParam(ws)).
 		Param(ws.QueryParameter("export", "Should this value be exported. Export strips fields that a user can not specify.").DataType("boolean")).
-		Param(ws.QueryParameter("exact", "Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'").DataType("boolean"))
+		Param(ws.QueryParameter("exact", "Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'").DataType("boolean")).
+		Param(ws.QueryParameter("watch", "Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.").DataType("boolean"))
 }
 
 func addPostParams(builder *restful.RouteBuilder, ws *restful.WebService) *restful.RouteBuilder {