Update listsecret return to send a JSON object

[aaf/sms.git] / sms-service / doc / api_swagger.html
diff --git a/sms-service/doc/api_swagger.html b/sms-service/doc/api_swagger.html

index 94a72aa..7f987a3 100644 (file)
--- a/sms-service/doc/api_swagger.html
+++ b/sms-service/doc/api_swagger.html
@@ -181,7 +181,7 @@ font-style: italic;
    <body>
    <h1>Secret Management Service</h1>
      <div class="app-desc">This is a service that provides secret management facilities</div>
-    <div class="app-desc">More information: <a href=""></a></div>
+    <div class="app-desc">More information: <a href="https://helloreverb.com">https://helloreverb.com</a></div>
      <div class="app-desc">Contact Info: <a href="kiran.k.kamineni@intel.com">kiran.k.kamineni@intel.com</a></div>
      <div class="app-desc">Version: 1.0.0</div>
      <div class="app-desc">BasePath:/v1/sms/</div>
@@ -295,8 +295,8 @@ font-style: italic;
      <h3 class="field-label">Example data</h3>
      <div class="example-data-content-type">Content-Type: application/json</div>
      <pre class="example"><code>{
-  "name" : "aeiou",
-  "uuid" : "aeiou"
+  "name" : "name",
+  "uuid" : "uuid"
  }</code></pre>
  
      <h3 class="field-label">Produces</h3>
@@ -356,7 +356,7 @@ font-style: italic;
      <div class="example-data-content-type">Content-Type: application/json</div>
      <pre class="example"><code>{
    "ttl" : 0,
-  "token" : "aeiou"
+  "token" : "token"
  }</code></pre>
  
      <h3 class="field-label">Produces</h3>
@@ -397,15 +397,15 @@ font-style: italic;
  
      <h3 class="field-label">Return type</h3>
      <div class="return-type">
+      <a href="#inline_response_200_2">inline_response_200_2</a>
        
-      array[String]
      </div>
  
      <!--Todo: process Response Object and its headers, schema, examples -->
  
      <h3 class="field-label">Example data</h3>
      <div class="example-data-content-type">Content-Type: application/json</div>
-    <pre class="example"><code>[ "secret1", "secret2", "secret3" ]</code></pre>
+    <pre class="example"><code>"{\"secretnames\":[\"secretname1\",\"secretname2\",\"secretname3\"]}"</code></pre>
  
      <h3 class="field-label">Produces</h3>
      This API call produces the following media types according to the <span class="header">Accept</span> request header;
@@ -417,7 +417,7 @@ font-style: italic;
      <h3 class="field-label">Responses</h3>
      <h4 class="field-label">200</h4>
      Successful operation
-        
+        <a href="#inline_response_200_2">inline_response_200_2</a>
      <h4 class="field-label">404</h4>
      Invalid Path or Path not found
          <a href="#"></a>
@@ -552,7 +552,7 @@ font-style: italic;
      "Age" : 40,
      "admin" : true
    },
-  "name" : "aeiou"
+  "name" : "name"
  }</code></pre>
  
      <h3 class="field-label">Produces</h3>
@@ -596,7 +596,7 @@ font-style: italic;
      <h3 class="field-label">Example data</h3>
      <div class="example-data-content-type">Content-Type: application/json</div>
      <pre class="example"><code>{
-  "sealstatus" : "aeiou"
+  "sealstatus" : "sealstatus"
  }</code></pre>
  
      <h3 class="field-label">Produces</h3>
@@ -672,6 +672,7 @@ font-style: italic;
      <li><a href="#body"><code>body</code> - </a></li>
      <li><a href="#inline_response_200"><code>inline_response_200</code> - </a></li>
      <li><a href="#inline_response_200_1"><code>inline_response_200_1</code> - </a></li>
+    <li><a href="#inline_response_200_2"><code>inline_response_200_2</code> - </a></li>
    </ol>
  
    <div class="model">
@@ -720,5 +721,12 @@ font-style: italic;
        <div class="param">sealstatus (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> seal status of backend </div>
      </div>  <!-- field-items -->
    </div>
+  <div class="model">
+    <h3><a name="inline_response_200_2"><code>inline_response_200_2</code> - </a> <a class="up" href="#__Models">Up</a></h3>
+    
+    <div class="field-items">
+      <div class="param">secretnames (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">array[String]</a></span> Array of strings referencing the secret names </div>
+    </div>  <!-- field-items -->
+  </div>
    </body>
  </html>