Update service catalog swagger as per suggested guidelines.

[externalapi/nbi.git] / docs / offeredapis / api_serviceCatalog / swagger.yaml

diff --git a/docs/offeredapis/api_serviceCatalog/swagger.yaml b/docs/offeredapis/api_serviceCatalog/swagger.yaml
index f8eb540..b0716cb 100644 (file)
--- a/docs/offeredapis/api_serviceCatalog/swagger.yaml
+++ b/docs/offeredapis/api_serviceCatalog/swagger.yaml
@@ -13,18 +13,28 @@
 #    limitations under the License.swagger: "2.0"
 swagger: "2.0"
 info:
-  description: "serviceCatalog API designed for ONAP Beijing Release.\nThis API is\
+  description: "ServiceCatalog API to retrieve Service Specifications that are available from ONAP.\nThis API is\
     \ build from TMF open API17.5. \nOnly operation GET (by id & byList) for resource\
-    \ serviceSpecification is available\n\n"
+    \ serviceSpecification is available\n \
+    \ To view this swagger file import it into https://editor.swagger.io/ \n"
   version: "4.0.1"
-  title: "API ServiceCatalog"
+  title: "ServiceCatalog API"
+  contact:
+    name: "ONAP"
+    url: "https://onap.readthedocs.io"
+    email: "onap-discuss@lists.onap.org"
+  license:
+    name: "Apache 2.0"
+    url: "http://www.apache.org/licenses/LICENSE-2.0"
+  x-planned-retirement-date: "205001"
+  x-component: "NBI"
   x-logo:
     url: "/redoc/logo.png"
     backgroundColor: "#FFFFFF"
-host: "serverRoot"
+host: "serverRoot:30274"
 basePath: "/nbi/api/v4"
 schemes:
-- "https"
+- "http"
 produces:
 - "application/json;charset=utf-8"
 tags:
@@ -37,7 +47,7 @@ paths:
       - "ServiceSpecification"
       produces:
       - "application/json;charset=utf-8"
-      operationId: "serviceSpecificationFind"
+      operationId: "serviceSpecification_Find"
       summary: "List service specifications"
       description: "This operation returns service specifications from a catalog.\n\
         Only a predefined set of attribute is proposed : Based on SDC limitations,\
@@ -112,7 +122,7 @@ paths:
       - "ServiceSpecification"
       produces:
       - "application/json;charset=utf-8"
-      operationId: "serviceSpecificationGet"
+      operationId: "serviceSpecification_Get"
       summary: "Retrieve a service specification"
       description: "This operation returns a service specification by its id from\
         \ a catalog. Attribute selection is enabled using the fields attribute."