Rename api path /details/ to /detail/ for consistency CSCDP#9

SocialFinanceDigitalLabs · Feb 13, 2020 · 3aa2364 · 3aa2364
1 parent 783b939
commit 3aa2364
Show file tree

Hide file tree

Showing 5 changed files with 15 additions and 15 deletions.
diff --git a/client/docs/api/PersonApi.md b/client/docs/api/PersonApi.md
@@ -4,11 +4,11 @@ All URIs are relative to */*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**getPersonById**](PersonApi.md#getPersonById) | **GET** /api/person/details/{personId} | Find person by ID
+[**getPersonById**](PersonApi.md#getPersonById) | **GET** /api/person/detail/{personId} | Find person by ID
 [**getPersonRelated**](PersonApi.md#getPersonRelated) | **GET** /api/person/related/{personId}/ | Get related individuals
 [**getPersonRelatedSupported**](PersonApi.md#getPersonRelatedSupported) | **HEAD** /api/person/related/{personId}/ | Is related person supported
-[**getPersonServiceByTypeAndId**](PersonApi.md#getPersonServiceByTypeAndId) | **GET** /api/person/details/{personId}/service/{serviceType} | Find person by ID
-[**getPersonServicesById**](PersonApi.md#getPersonServicesById) | **GET** /api/person/details/{personId}/service | Get a summary of the services a person has interacted with
+[**getPersonServiceByTypeAndId**](PersonApi.md#getPersonServiceByTypeAndId) | **GET** /api/person/detail/{personId}/service/{serviceType} | Find person by ID
+[**getPersonServicesById**](PersonApi.md#getPersonServicesById) | **GET** /api/person/detail/{personId}/service | Get a summary of the services a person has interacted with
 [**searchPerson**](PersonApi.md#searchPerson) | **POST** /api/search/person | Search for a person
 [**searchPersonSupported**](PersonApi.md#searchPersonSupported) | **HEAD** /api/search/person | Is person search supported
 

diff --git a/client/src/api/api/PersonApi.js b/client/src/api/api/PersonApi.js
@@ -62,7 +62,7 @@ export default class PersonApi {
       let returnType = Person;
 
       return this.apiClient.callApi(
-        '/api/person/details/{personId}', 'GET',
+        '/api/person/detail/{personId}', 'GET',
         pathParams, queryParams, headerParams, formParams, postBody,
         authNames, contentTypes, accepts, returnType
       );
@@ -192,7 +192,7 @@ export default class PersonApi {
       let returnType = ServiceDetail;
 
       return this.apiClient.callApi(
-        '/api/person/details/{personId}/service/{serviceType}', 'GET',
+        '/api/person/detail/{personId}/service/{serviceType}', 'GET',
         pathParams, queryParams, headerParams, formParams, postBody,
         authNames, contentTypes, accepts, returnType
       );
@@ -234,7 +234,7 @@ export default class PersonApi {
       let returnType = [ServiceSummary];
 
       return this.apiClient.callApi(
-        '/api/person/details/{personId}/service', 'GET',
+        '/api/person/detail/{personId}/service', 'GET',
         pathParams, queryParams, headerParams, formParams, postBody,
         authNames, contentTypes, accepts, returnType
       );

diff --git a/schema/family-context-api.yaml b/schema/family-context-api.yaml
@@ -112,7 +112,7 @@ paths:
           description: Person search is not supported by this application
 
 
-  /api/person/details/{personId}:
+  /api/person/detail/{personId}:
     get:
       summary: Find person by ID
       description: Returns a single person
@@ -137,7 +137,7 @@ paths:
           description: Person not found
           content: {}
 
-  /api/person/details/{personId}/service:
+  /api/person/detail/{personId}/service:
     get:
       summary: Get a summary of the services a person has interacted with
       operationId: getPersonServicesById
@@ -163,7 +163,7 @@ paths:
           description: Person not found
           content: {}
 
-  /api/person/details/{personId}/service/{serviceType}:
+  /api/person/detail/{personId}/service/{serviceType}:
     get:
       summary: Find person by ID
       description: Returns a single person

diff --git a/server/swagger_server/swagger/swagger.yaml b/server/swagger_server/swagger/swagger.yaml
@@ -94,7 +94,7 @@ paths:
         "501":
           description: Person search is not supported by this application
       x-openapi-router-controller: swagger_server.controllers.person_controller
-  /api/person/details/{personId}:
+  /api/person/detail/{personId}:
     get:
       tags:
       - person
@@ -121,7 +121,7 @@ paths:
           description: Person not found
           content: {}
       x-openapi-router-controller: swagger_server.controllers.person_controller
-  /api/person/details/{personId}/service:
+  /api/person/detail/{personId}/service:
     get:
       tags:
       - person
@@ -150,7 +150,7 @@ paths:
           description: Person not found
           content: {}
       x-openapi-router-controller: swagger_server.controllers.person_controller
-  /api/person/details/{personId}/service/{serviceType}:
+  /api/person/detail/{personId}/service/{serviceType}:
     get:
       tags:
       - person

diff --git a/server/swagger_server/test/test_person_controller.py b/server/swagger_server/test/test_person_controller.py
@@ -22,7 +22,7 @@ def test_get_person_by_id(self):
         Find person by ID
         """
         response = self.client.open(
-            '/api/person/details/{personId}'.format(person_id='person_id_example'),
+            '/api/person/detail/{personId}'.format(person_id='person_id_example'),
             method='GET')
         self.assert200(response,
                        'Response body is : ' + response.data.decode('utf-8'))
@@ -55,7 +55,7 @@ def test_get_person_service_by_type_and_id(self):
         Find person by ID
         """
         response = self.client.open(
-            '/api/person/details/{personId}/service/{serviceType}'.format(person_id='person_id_example', service_type='service_type_example'),
+            '/api/person/detail/{personId}/service/{serviceType}'.format(person_id='person_id_example', service_type='service_type_example'),
             method='GET')
         self.assert200(response,
                        'Response body is : ' + response.data.decode('utf-8'))
@@ -66,7 +66,7 @@ def test_get_person_services_by_id(self):
         Get a summary of the services a person has interacted with
         """
         response = self.client.open(
-            '/api/person/details/{personId}/service'.format(person_id='person_id_example'),
+            '/api/person/detail/{personId}/service'.format(person_id='person_id_example'),
             method='GET')
         self.assert200(response,
                        'Response body is : ' + response.data.decode('utf-8'))