diff options
author | Kiran Kamineni <kiran.k.kamineni@intel.com> | 2018-03-13 12:59:37 -0700 |
---|---|---|
committer | Girish Havaldar <hg0071052@techmahindra.com> | 2018-03-15 17:00:33 +0000 |
commit | 9b16de820c0bef5643746bdeb3186714a85281f1 (patch) | |
tree | 44cfb4ed3f1f22de9bc69edd62b83d3f033cfa99 /sms-service/doc/api_swagger.yaml | |
parent | 75dd5474ec6a2a1c4fbf513e82ba6f4ae08f85f6 (diff) |
Update listsecret return to send a JSON object
Instead of sending JSONArray, retrun JSON object
for consistency and client processing
Issue-ID: AAF-172
Change-Id: I17d2e2c2865a817c8016987f998c87259413f306
Signed-off-by: Kiran Kamineni <kiran.k.kamineni@intel.com>
Diffstat (limited to 'sms-service/doc/api_swagger.yaml')
-rw-r--r-- | sms-service/doc/api_swagger.yaml | 31 |
1 files changed, 19 insertions, 12 deletions
diff --git a/sms-service/doc/api_swagger.yaml b/sms-service/doc/api_swagger.yaml index 08e3c18..61cd091 100644 --- a/sms-service/doc/api_swagger.yaml +++ b/sms-service/doc/api_swagger.yaml @@ -89,12 +89,14 @@ paths: properties: unsealshard: type: string - description: Unseal shard that will be used along with other shards to unseal backend + description: >- + Unseal shard that will be used along with other shards to + unseal backend responses: '201': description: Submitted unseal key '404': - description: Invalid Path or Path not found + description: Invalid Path or Path not found /domain: post: tags: @@ -182,10 +184,15 @@ paths: '200': description: Successful operation schema: - type: array - items: - type: string - example: ['secret1', 'secret2', 'secret3'] + type: object + properties: + secretnames: + type: array + items: + type: string + description: Array of strings referencing the secret names + example: + secretnames: ["secretname1", "secretname2", "secretname3"] '404': description: Invalid Path or Path not found '/domain/{domainName}/secret/{secretName}': @@ -239,9 +246,9 @@ paths: description: Invalid Path or Path not found securityDefinitions: token: - type: "apiKey" - name: "token" - in: "header" + type: apiKey + name: token + in: header definitions: Credential: type: object @@ -273,9 +280,9 @@ definitions: additionalProperties: type: object example: - "name": "john" - "Age": 40 - "admin": true + name: john + Age: 40 + admin: true externalDocs: description: Find out more about Swagger url: 'http://swagger.io' |