Shortening swagger spec nicknames

This is being done because titles have become so long in index of
documentation [0] that they don't fit in one line.

[0] http://artifacts.opnfv.org/releng/docs/testapi.html

JIRA: FUNCTEST-704

Change-Id: I046a21d7ceac6dc203ac71d169d4303095bdc69c
Signed-off-by: rohitsakala <rohitsakala@gmail.com>

diff --git a/utils/test/testapi/opnfv_testapi/resources/handlers.py b/utils/test/testapi/opnfv_testapi/resources/handlers.py
index 9fc5d6b..5f6c3df 100644 (file)
--- a/utils/test/testapi/opnfv_testapi/resources/handlers.py
+++ b/utils/test/testapi/opnfv_testapi/resources/handlers.py
@@ -228,7 +228,7 @@ class GenericApiHandler(RequestHandler):
 
 
 class VersionHandler(GenericApiHandler):
-    @swagger.operation(nickname='List all versions')
+    @swagger.operation(nickname='listAllVersions')
     def get(self):
         """
             @description: list all supported versions

diff --git a/utils/test/testapi/opnfv_testapi/resources/pod_handlers.py b/utils/test/testapi/opnfv_testapi/resources/pod_handlers.py
index 631d4a9..e1bd9d3 100644 (file)
--- a/utils/test/testapi/opnfv_testapi/resources/pod_handlers.py
+++ b/utils/test/testapi/opnfv_testapi/resources/pod_handlers.py
@@ -20,7 +20,7 @@ class GenericPodHandler(GenericApiHandler):
 
 
 class PodCLHandler(GenericPodHandler):
-    @swagger.operation(nickname='List all Pods')
+    @swagger.operation(nickname='listAllPods')
     def get(self):
         """
             @description: list all pods
@@ -29,7 +29,7 @@ class PodCLHandler(GenericPodHandler):
         """
         self._list()
 
-    @swagger.operation(nickname='Create a Pod')
+    @swagger.operation(nickname='createPod')
     def post(self):
         """
             @description: create a pod
@@ -54,7 +54,7 @@ class PodCLHandler(GenericPodHandler):
 
 
 class PodGURHandler(GenericPodHandler):
-    @swagger.operation(nickname='Get a Pod by pod_name')
+    @swagger.operation(nickname='getPodByName')
     def get(self, pod_name):
         """
             @description: get a single pod by pod_name

diff --git a/utils/test/testapi/opnfv_testapi/resources/project_handlers.py b/utils/test/testapi/opnfv_testapi/resources/project_handlers.py
index 9cf6986..94c65b7 100644 (file)
--- a/utils/test/testapi/opnfv_testapi/resources/project_handlers.py
+++ b/utils/test/testapi/opnfv_testapi/resources/project_handlers.py
@@ -22,7 +22,7 @@ class GenericProjectHandler(GenericApiHandler):
 
 
 class ProjectCLHandler(GenericProjectHandler):
-    @swagger.operation(nickname="List all Projects")
+    @swagger.operation(nickname="listAllProjects")
     def get(self):
         """
             @description: list all projects
@@ -31,7 +31,7 @@ class ProjectCLHandler(GenericProjectHandler):
         """
         self._list()
 
-    @swagger.operation(nickname="Create a Project")
+    @swagger.operation(nickname="createProject")
     def post(self):
         """
             @description: create a project
@@ -56,7 +56,7 @@ class ProjectCLHandler(GenericProjectHandler):
 
 
 class ProjectGURHandler(GenericProjectHandler):
-    @swagger.operation(nickname='Get a Project by project_name')
+    @swagger.operation(nickname='getProjectByName')
     def get(self, project_name):
         """
             @description: get a single project by project_name
@@ -66,7 +66,7 @@ class ProjectGURHandler(GenericProjectHandler):
         """
         self._get_one({'name': project_name})
 
-    @swagger.operation(nickname="Update a Project by project_name")
+    @swagger.operation(nickname="updateProjectByName")
     def put(self, project_name):
         """
             @description: update a single project by project_name
@@ -82,7 +82,7 @@ class ProjectGURHandler(GenericProjectHandler):
         db_keys = ['name']
         self._update(query, db_keys)
 
-    @swagger.operation(nickname='Delete a Project by project_name')
+    @swagger.operation(nickname='deleteProjectByName')
     def delete(self, project_name):
         """
             @description: delete a project by project_name

diff --git a/utils/test/testapi/opnfv_testapi/resources/result_handlers.py b/utils/test/testapi/opnfv_testapi/resources/result_handlers.py
index fe13c09..2a1ed56 100644 (file)
--- a/utils/test/testapi/opnfv_testapi/resources/result_handlers.py
+++ b/utils/test/testapi/opnfv_testapi/resources/result_handlers.py
@@ -52,7 +52,7 @@ class GenericResultHandler(GenericApiHandler):
 
 
 class ResultsCLHandler(GenericResultHandler):
-    @swagger.operation(nickname="List all Test Results")
+    @swagger.operation(nickname="queryTestResults")
     def get(self):
         """
             @description: Retrieve result(s) for a test project
@@ -127,7 +127,7 @@ class ResultsCLHandler(GenericResultHandler):
 
         self._list(self.set_query(), sort=[('start_date', -1)], last=last)
 
-    @swagger.operation(nickname="Create a Test Result")
+    @swagger.operation(nickname="createTestResult")
     def post(self):
         """
             @description: create a test result
@@ -169,7 +169,7 @@ class ResultsCLHandler(GenericResultHandler):
 
 
 class ResultsGURHandler(GenericResultHandler):
-    @swagger.operation(nickname='Get a Test Result by result_id')
+    @swagger.operation(nickname='getTestResultById')
     def get(self, result_id):
         """
             @description: get a single result by result_id
@@ -181,7 +181,7 @@ class ResultsGURHandler(GenericResultHandler):
         query["_id"] = ObjectId(result_id)
         self._get_one(query)
 
-    @swagger.operation(nickname="Update a Test Result by result_id")
+    @swagger.operation(nickname="updateTestResultById")
     def put(self, result_id):
         """
             @description: update a single result by _id

diff --git a/utils/test/testapi/opnfv_testapi/resources/scenario_handlers.py b/utils/test/testapi/opnfv_testapi/resources/scenario_handlers.py
index 28fe28e..a9b89eb 100644 (file)
--- a/utils/test/testapi/opnfv_testapi/resources/scenario_handlers.py
+++ b/utils/test/testapi/opnfv_testapi/resources/scenario_handlers.py
@@ -14,7 +14,7 @@ class GenericScenarioHandler(GenericApiHandler):
 
 
 class ScenariosCLHandler(GenericScenarioHandler):
-    @swagger.operation(nickname="List scenarios by queries")
+    @swagger.operation(nickname="queryScenarios")
     def get(self):
         """
             @description: Retrieve scenario(s).
@@ -63,7 +63,7 @@ class ScenariosCLHandler(GenericScenarioHandler):
 
         self._list(_set_query())
 
-    @swagger.operation(nickname="Create a new scenario")
+    @swagger.operation(nickname="createScenario")
     def post(self):
         """
             @description: create a new scenario by name
@@ -88,7 +88,7 @@ class ScenariosCLHandler(GenericScenarioHandler):
 
 
 class ScenarioGURHandler(GenericScenarioHandler):
-    @swagger.operation(nickname='Get the scenario by name')
+    @swagger.operation(nickname='getScenarioByName')
     def get(self, name):
         """
             @description: get a single scenario by name
@@ -99,7 +99,7 @@ class ScenarioGURHandler(GenericScenarioHandler):
         self._get_one({'name': name})
         pass
 
-    @swagger.operation(nickname="Update the scenario by name")
+    @swagger.operation(nickname="updateScenarioByName")
     def put(self, name):
         """
             @description: update a single scenario by name

diff --git a/utils/test/testapi/opnfv_testapi/resources/testcase_handlers.py b/utils/test/testapi/opnfv_testapi/resources/testcase_handlers.py
index 3692b16..100a4fd 100644 (file)
--- a/utils/test/testapi/opnfv_testapi/resources/testcase_handlers.py
+++ b/utils/test/testapi/opnfv_testapi/resources/testcase_handlers.py
@@ -22,7 +22,7 @@ class GenericTestcaseHandler(GenericApiHandler):
 
 
 class TestcaseCLHandler(GenericTestcaseHandler):
-    @swagger.operation(nickname="List all TestCases by project_name")
+    @swagger.operation(nickname="listAllTestCases")
     def get(self, project_name):
         """
             @description: list all testcases of a project by project_name
@@ -34,7 +34,7 @@ class TestcaseCLHandler(GenericTestcaseHandler):
         query['project_name'] = project_name
         self._list(query)
 
-    @swagger.operation(nickname="Create a TestCase by project_name")
+    @swagger.operation(nickname="createTestCase")
     def post(self, project_name):
         """
             @description: create a testcase of a project by project_name
@@ -72,7 +72,7 @@ class TestcaseCLHandler(GenericTestcaseHandler):
 
 
 class TestcaseGURHandler(GenericTestcaseHandler):
-    @swagger.operation(nickname='Get a TestCase by project and case name')
+    @swagger.operation(nickname='getTestCaseByName')
     def get(self, project_name, case_name):
         """
             @description: get a single testcase
@@ -86,7 +86,7 @@ class TestcaseGURHandler(GenericTestcaseHandler):
         query["name"] = case_name
         self._get_one(query)
 
-    @swagger.operation(nickname="Update a TestCase by project and case name")
+    @swagger.operation(nickname="updateTestCaseByName")
     def put(self, project_name, case_name):
         """
             @description: update a single testcase
@@ -104,7 +104,7 @@ class TestcaseGURHandler(GenericTestcaseHandler):
         db_keys = ['name', 'project_name']
         self._update(query, db_keys)
 
-    @swagger.operation(nickname='Delete a TestCase by project and case name')
+    @swagger.operation(nickname='deleteTestCaseByName')
     def delete(self, project_name, case_name):
         """
             @description: delete a testcase by project_name and case_name