From b60afbfc4881f8780e044bc59c108785b825cbf0 Mon Sep 17 00:00:00 2001
From: "dr.max" <maximilien@acm.org>
Date: Thu, 25 Aug 2016 15:21:11 -0700
Subject: [PATCH] fist pass of Swagger description for BOSH config-server

---
 .../bosh/config-server/config-server.yml      | 105 ++++++++++++++++++
 1 file changed, 105 insertions(+)
 create mode 100644 descriptions/bosh/config-server/config-server.yml

diff --git a/descriptions/bosh/config-server/config-server.yml b/descriptions/bosh/config-server/config-server.yml
new file mode 100644
index 0000000..786f4ef
--- /dev/null
+++ b/descriptions/bosh/config-server/config-server.yml
@@ -0,0 +1,105 @@
+swagger: '2.0'
+info:
+  title: Config Server
+  description: BOSH config server REST APIs
+  version: "0.1.0"
+host: api.bosh.io
+schemes:
+  - https
+basePath: /v1
+produces:
+  - application/json
+paths:
+  /data/someKeyPath:
+    get:
+      summary: returns the config data added
+      description: |
+        whenever Director needs to retrieve a value it will use GET action.
+      parameters:
+        - name: someKeyPath
+          in: query
+          description: the path to the key to retrieve.
+          required: true
+          type: string
+      responses:
+        200:
+          description: the JSON that was added for that path
+          schema:
+            $ref: '#/definitions/Data'
+        default:
+          description: Unexpected error
+          schema:
+            $ref: '#/definitions/Error'
+    delete:
+      summary: deletes the value associated with this path
+      description: user can delete config values
+      parameters:
+        - name: someKeyPath
+          in: query
+          description: the path to the key to retrieve.
+          required: true
+          type: string
+      responses:
+        200:
+          description: OK
+        default:
+          description: Unexpected error
+          schema:
+            $ref: '#/definitions/Error'
+    put:
+      summary: updates the config data associated with someKeyPath
+      description: manual config value update
+      parameters:
+        - name: someKeyPath
+          in: query
+          description: the path to the key to retrieve.
+          required: true
+          type: string
+        - name: request
+          in: body
+          description: the data to update
+          required: true
+          schema:
+            $ref: '#/definitions/Data'
+      responses:
+        200:
+          description: OK
+        default:
+          description: Unexpected error
+          schema:
+            $ref: '#/definitions/Error'
+    post:
+      summary: creates the config data associated with someKeyPath
+      description: whenever Director generates a value it will be saved into the config server
+      parameters:
+        - name: someKeyPath
+          in: query
+          description: the path to the key to retrieve.
+          required: true
+          type: string
+        - name: request
+          in: body
+          description: the data to update
+          required: true
+          schema:
+            $ref: '#/definitions/Data'
+      responses:
+        200:
+          description: OK
+definitions:
+  Data:
+    type: object
+    description: the value for the data
+    properties:
+      type:
+        type: string
+        description: the string name of the type for the value 
+  Error:
+    properties:
+      code:
+        type: integer
+        format: int32
+      message:
+        type: string
+      fields:
+        type: string
\ No newline at end of file