From 31a0daae3627c91bc96e1f02a6344cd76e294791 Mon Sep 17 00:00:00 2001 From: Brian Grant Date: Tue, 19 Aug 2014 19:48:12 +0000 Subject: [PATCH] Add containerPort to service schema. Regenerate HTML. Add instructions for how to view HTML. --- README.md | 7 ++++++- api/doc/service-schema.json | 4 ++++ api/kubernetes.html | 16 ++++++++++++---- 3 files changed, 22 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 7a628234db..f80c34a66c 100644 --- a/README.md +++ b/README.md @@ -178,7 +178,7 @@ git fetch upstream git rebase upstream/master ``` -### Regenerating the documentation +### Regenerating the API documentation ``` cd kubernetes/api @@ -186,3 +186,8 @@ sudo docker build -t kubernetes/raml2html . sudo docker run --name="docgen" kubernetes/raml2html sudo docker cp docgen:/data/kubernetes.html . ``` + +View the API documentation using htmlpreview (works on your fork, too): +``` +http://htmlpreview.github.io/?https://github.com/GoogleCloudPlatform/kubernetes/blob/master/api/kubernetes.html +``` diff --git a/api/doc/service-schema.json b/api/doc/service-schema.json index 097c95482c..750bca469c 100644 --- a/api/doc/service-schema.json +++ b/api/doc/service-schema.json @@ -28,6 +28,10 @@ "type": "number", "required": false }, + "containerPort": { + "type": "string", + "required": false + }, "labels": { "type": "object", "required": false diff --git a/api/kubernetes.html b/api/kubernetes.html index 1d4d034183..b420f2ed9d 100644 --- a/api/kubernetes.html +++ b/api/kubernetes.html @@ -279,7 +279,7 @@ "name": "foo" } } - +

get put delete

get

Get a specific pod

 put

Update a pod

 delete

Delete a specific pod

Get a specific pod

URI Parameters

  • podId: required (string)

HTTP status code 200

Body

Type: application/json

Example:

{
   "kind": "Pod",
   "apiVersion": "v1beta1",
@@ -311,7 +311,7 @@
     "name": "foo"
   }
 }
-    
+

Update a pod

URI Parameters

  • podId: required (string)

Body

Type: application/json

Schema:

{
   "$schema": "http://json-schema.org/draft-03/schema",
   "type": "object",
@@ -430,7 +430,7 @@
     "name": "foo"
   }
 }
-    
+

Delete a specific pod

URI Parameters

  • podId: required (string)

HTTP status code 200

Body

Type: application/json

Example:

{ 
   "success": true
 }
@@ -699,6 +699,10 @@
       "type": "number",
       "required": false
     },
+    "containerPort": {
+      "type": "string",
+      "required": false
+    },
     "labels": {
       "type": "object",
       "required": false
@@ -763,6 +767,10 @@
       "type": "number",
       "required": false
     },
+    "containerPort": {
+      "type": "string",
+      "required": false
+    },
     "labels": {
       "type": "object",
       "required": false
@@ -788,4 +796,4 @@

Delete a specific service

URI Parameters

  • serviceId: required (string)

HTTP status code 200

Body

Type: application/json

Example:

{ 
   "success": true
 }
-

+

\ No newline at end of file