doc_storage: add api changes

2600hz · Dec 16, 2016 · 0e5027c · 0e5027c
1 parent bf2a5ba
commit 0e5027c
Show file tree

Hide file tree

Showing 3 changed files with 71 additions and 0 deletions.
diff --git a/applications/crossbar/doc/ref/storage.md b/applications/crossbar/doc/ref/storage.md
@@ -8,6 +8,7 @@ Key | Description | Type | Default | Required
 --- | ----------- | ---- | ------- | --------
 `attachments` | Defines where and how to store attachments | [#/definitions/storage.attachments](#storageattachments) |   | `false`
 `connections` | Describes alternative connections to use (such as alternative CouchDB instances | [#/definitions/storage.connections](#storageconnections) |   | `false`
+`id` | ID of the storage document | `string` |   | `false`
 `plan` | Describes how to store documents depending on the database or document type | [#/definitions/storage.plan](#storageplan) |   | `false`
 
 
@@ -143,6 +144,16 @@ curl -v -X POST \
     http://{SERVER}:8000/v2/accounts/{ACCOUNT_ID}/storage
 ```
 
+#### Patch
+
+> PATCH /v2/accounts/{ACCOUNT_ID}/storage
+
+```shell
+curl -v -X PATCH \
+    -H "X-Auth-Token: {AUTH_TOKEN}" \
+    http://{SERVER}:8000/v2/accounts/{ACCOUNT_ID}/storage
+```
+
 #### Remove
 
 > DELETE /v2/accounts/{ACCOUNT_ID}/storage
@@ -193,6 +204,16 @@ curl -v -X POST \
     http://{SERVER}:8000/v2/accounts/{ACCOUNT_ID}/storage/plans/{STORAGE_PLAN_ID}
 ```
 
+#### Patch
+
+> PATCH /v2/accounts/{ACCOUNT_ID}/storage/plans/{STORAGE_PLAN_ID}
+
+```shell
+curl -v -X PATCH \
+    -H "X-Auth-Token: {AUTH_TOKEN}" \
+    http://{SERVER}:8000/v2/accounts/{ACCOUNT_ID}/storage/plans/{STORAGE_PLAN_ID}
+```
+
 #### Remove
 
 > DELETE /v2/accounts/{ACCOUNT_ID}/storage/plans/{STORAGE_PLAN_ID}

diff --git a/applications/crossbar/doc/storage.md b/applications/crossbar/doc/storage.md
@@ -44,6 +44,7 @@ Key | Description | Type | Default | Required
 --- | ----------- | ---- | ------- | --------
 `attachments` | Defines where and how to store attachments | [#/definitions/storage.attachments](#storageattachments) |   | `false`
 `connections` | Describes alternative connections to use (such as alternative CouchDB instances | [#/definitions/storage.connections](#storageconnections) |   | `false`
+`id` | ID of the storage document | `string` |   | `false`
 `plan` | Describes how to store documents depending on the database or document type | [#/definitions/storage.plan](#storageplan) |   | `false`
 
 
@@ -218,6 +219,16 @@ curl -v -X POST \
     http://{SERVER}:8000/v2/accounts/{ACCOUNT_ID}/storage
 ```
 
+#### Patch
+
+> PATCH /v2/accounts/{ACCOUNT_ID}/storage
+
+```shell
+curl -v -X PATCH \
+    -H "X-Auth-Token: {AUTH_TOKEN}" \
+    http://{SERVER}:8000/v2/accounts/{ACCOUNT_ID}/storage
+```
+
 #### Remove
 
 > DELETE /v2/accounts/{ACCOUNT_ID}/storage
@@ -268,6 +279,16 @@ curl -v -X POST \
     http://{SERVER}:8000/v2/accounts/{ACCOUNT_ID}/storage/plans/{STORAGE_PLAN_ID}
 ```
 
+#### Patch
+
+> PATCH /v2/accounts/{ACCOUNT_ID}/storage/plans/{STORAGE_PLAN_ID}
+
+```shell
+curl -v -X PATCH \
+    -H "X-Auth-Token: {AUTH_TOKEN}" \
+    http://{SERVER}:8000/v2/accounts/{ACCOUNT_ID}/storage/plans/{STORAGE_PLAN_ID}
+```
+
 #### Remove
 
 > DELETE /v2/accounts/{ACCOUNT_ID}/storage/plans/{STORAGE_PLAN_ID}

diff --git a/applications/crossbar/priv/api/swagger.json b/applications/crossbar/priv/api/swagger.json
@@ -6798,6 +6798,10 @@
                     "$ref": "storage.connections",
                     "description": "Describes alternative connections to use (such as alternative CouchDB instances"
                 },
+                "id": {
+                    "description": "ID of the storage document",
+                    "type": "string"
+                },
                 "plan": {
                     "$ref": "storage.plan",
                     "description": "Describes how to store documents depending on the database or document type"
@@ -19448,6 +19452,17 @@
                     }
                 ]
             },
+            "patch": {
+                "parameters": [
+                    {
+                        "$ref": "#/parameters/auth_token_header",
+                        "required": true
+                    },
+                    {
+                        "$ref": "#/parameters/account_id"
+                    }
+                ]
+            },
             "post": {
                 "parameters": [
                     {
@@ -19548,6 +19563,20 @@
                     }
                 ]
             },
+            "patch": {
+                "parameters": [
+                    {
+                        "$ref": "#/parameters/storage_plan_id"
+                    },
+                    {
+                        "$ref": "#/parameters/auth_token_header",
+                        "required": true
+                    },
+                    {
+                        "$ref": "#/parameters/account_id"
+                    }
+                ]
+            },
             "post": {
                 "parameters": [
                     {