Merge pull request #148 from Lull3rSkat3r/issue-146-add-endpoints-to-…

…swagger [Issue 146]: Updated Swagger docs
jupyter-server · Apr 1, 2016 · 7a794a6 · 7a794a6
2 parents ec87f88 + 8b5e831
commit 7a794a6
Show file tree

Hide file tree

Showing 2 changed files with 162 additions and 1 deletion.
diff --git a/kernel_gateway/services/api/swagger.json b/kernel_gateway/services/api/swagger.json
@@ -42,6 +42,51 @@
         }
     },
     "paths": {
+        "/api": {
+            "get": {
+                "summary": "Get API info",
+                "tags": [
+                    "api"
+                ],
+                "responses": {
+                    "200": {
+                        "description": "Returns information about the API",
+                        "schema": {
+                            "$ref": "#/definitions/ApiInfo"
+                        }
+                    }
+                }
+            }
+        },
+        "/api/swagger.yaml": {
+            "get": {
+                "produces": [
+                    "text/x-yaml"
+                ],
+                "summary": "Get API info",
+                "tags": [
+                    "api"
+                ],
+                "responses": {
+                    "200": {
+                        "description": "Returns a swagger specification in yaml"
+                    }
+                }
+            }
+        },
+        "/api/swagger.json": {
+            "get": {
+                "summary": "Get API info",
+                "tags": [
+                    "api"
+                ],
+                "responses": {
+                    "200": {
+                        "description": "Returns a swagger specification in json"
+                    }
+                }
+            }
+        },
         "/api/kernelspecs": {
             "get": {
                 "security": [
@@ -192,6 +237,52 @@
                 }
             }
         },
+        "/kernels/{kernel_id}/interrupt": {
+            "parameters": [
+                {
+                    "$ref": "#/parameters/kernel"
+                }
+            ],
+            "post": {
+                "summary": "Interrupt a kernel",
+                "tags": [
+                    "kernels"
+                ],
+                "responses": {
+                    "204": {
+                        "description": "Kernel interrupted"
+                    }
+                }
+            }
+        },
+        "/kernels/{kernel_id}/restart": {
+            "parameters": [
+                {
+                    "$ref": "#/parameters/kernel"
+                }
+            ],
+            "post": {
+                "summary": "Restart a kernel",
+                "tags": [
+                    "kernels"
+                ],
+                "responses": {
+                    "200": {
+                        "description": "Kernel interrupted",
+                        "headers": {
+                            "Location": {
+                                "description": "URL for kernel commands",
+                                "type": "string",
+                                "format": "url"
+                            }
+                        },
+                        "schema": {
+                            "$ref": "#/definitions/Kernel"
+                        }
+                    }
+                }
+            }
+        },
         "/api/sessions": {
             "get": {
                 "summary": "List available sessions",
@@ -559,6 +650,15 @@
                     "$ref": "#/definitions/Kernel"
                 }
             }
+        },
+        "ApiInfo": {
+            "description": "Information about the api",
+            "type": "object",
+            "properties": {
+                "version": {
+                    "type": "string"
+                }
+            }
         }
     }
 }
diff --git a/kernel_gateway/services/api/swagger.yaml b/kernel_gateway/services/api/swagger.yaml
@@ -38,6 +38,34 @@ securityDefinitions:
       form of `token {value}` where `{value}` is the value of the token.
 
 paths:
+  /api:
+    get:
+      summary: Get API info
+      tags:
+        - api
+      responses:
+        200:
+          description: Returns information about the API
+          schema:
+            $ref: '#/definitions/ApiInfo'
+  /api/swagger.yaml:
+    get:
+      produces:
+        - text/x-yaml
+      summary: Get API info
+      tags:
+        - api
+      responses:
+        200:
+          description: Returns a swagger specification in yaml
+  /api/swagger.json:
+    get:
+      summary: Get API info
+      tags:
+        - api
+      responses:
+        200:
+          description: Returns a swagger specification in json
   /api/kernelspecs:
     get:
       security: 
@@ -132,6 +160,33 @@ paths:
       responses:
         200:
           description: The connection will be upgraded to a websocket.
+  /kernels/{kernel_id}/interrupt:
+    parameters:
+      - $ref: '#/parameters/kernel'
+    post:
+      summary: Interrupt a kernel
+      tags:
+        - kernels
+      responses:
+        204:
+          description: Kernel interrupted
+  /kernels/{kernel_id}/restart:
+    parameters:
+      - $ref: '#/parameters/kernel'
+    post:
+      summary: Restart a kernel
+      tags:
+        - kernels
+      responses:
+        200:
+          description: Kernel interrupted
+          headers:
+            Location:
+              description: URL for kernel commands
+              type: string
+              format: url
+          schema:
+            $ref: '#/definitions/Kernel'
   /api/sessions:
     get:
       summary: List available sessions
@@ -393,4 +448,10 @@ definitions:
             type: string
             description: path to notebook
       kernel:
-        $ref: '#/definitions/Kernel'
+        $ref: '#/definitions/Kernel'
+  ApiInfo:
+    description: Information about the api
+    type: object
+    properties:
+      version:
+        type: string