MHV-41829: Adjustments made to thread api (#11831)

* MHV-41829: Adjustments made to thread api * MHV-41829: Thread list api query parameters changed
department-of-veterans-affairs · Feb 24, 2023 · b52850f · b52850f
1 parent 0c6e640
commit b52850f
Show file tree

Hide file tree

Showing 10 changed files with 75 additions and 48 deletions.
diff --git a/lib/sm/client.rb b/lib/sm/client.rb
@@ -171,10 +171,10 @@ def get_folder_messages(user_uuid, folder_id, use_cache)
     #
     # @return [Common::Collection]
     #
-    def get_folder_threads(folder_id, page_start, page_end, sort_field, sort_order)
+    def get_folder_threads(folder_id, page_size, page_number, sort_field, sort_order)
       path = "folder/threadlistview/#{folder_id}"
 
-      params = "/pageStart/#{page_start}/pageEnd/#{page_end}/sortField/#{sort_field}/sortOrder/#{sort_order}"
+      params = "?pageSize=#{page_size}&pageNumber=#{page_number}&sortField=#{sort_field}&sortOrder=#{sort_order}"
 
       json = perform(:get, path + params, nil, token_headers).body
 

diff --git a/modules/my_health/app/controllers/my_health/v1/threads_controller.rb b/modules/my_health/app/controllers/my_health/v1/threads_controller.rb
@@ -6,8 +6,8 @@ class ThreadsController < SMController
       def index
         resource = client.get_folder_threads(
           params[:folder_id].to_s,
-          params[:page_start],
-          params[:page_end],
+          params[:page_size],
+          params[:page_number],
           params[:sort_field],
           params[:sort_order]
         )

diff --git a/modules/my_health/docs/openapi.yaml b/modules/my_health/docs/openapi.yaml
@@ -134,15 +134,15 @@ paths:
           required: true
           schema:
             type: string
-        - description: Pagination start numbering
+        - description: The size of the pagination you want
           in: query
-          name: pageStart,
+          name: pageSize,
           required: true
           schema:
             type: string
-        - description: Pagination end numbering (max 100)
+        - description: The page number to get based on your page size
           in: query
-          name: pageEnd,
+          name: pageNumber,
           required: true
           schema:
             type: string

diff --git a/modules/my_health/docs/openapi_merged.yaml b/modules/my_health/docs/openapi_merged.yaml
@@ -134,15 +134,15 @@ paths:
           required: true
           schema:
             type: string
-        - description: Pagination start numbering
+        - description: The size of the pagination you want
           in: query
-          name: pageStart,
+          name: pageSize,
           required: true
           schema:
             type: string
-        - description: Pagination end numbering (max 100)
+        - description: The page number to get based on your page size
           in: query
-          name: pageEnd,
+          name: pageNumber,
           required: true
           schema:
             type: string
@@ -1200,11 +1200,11 @@ components:
         category:
           type: string
           enum:
-            - OTHER
+            - OTHERS
             - COVID
             - APPOINTMENTS
             - MEDICATIONS
-            - TEST_RESULTS
+            - TEST_RESULT
             - EDUCATION
           example: MEDICATIONS
         subject:

diff --git a/modules/my_health/docs/schemas/SecureMessageThread.yml b/modules/my_health/docs/schemas/SecureMessageThread.yml
@@ -36,7 +36,7 @@ properties:
     example: 123
   category:
     type: string
-    enum: [OTHER, COVID, APPOINTMENTS, MEDICATIONS, TEST_RESULTS, EDUCATION]
+    enum: [OTHERS, COVID, APPOINTMENTS, MEDICATIONS, TEST_RESULT, EDUCATION]
     example: MEDICATIONS
   subject:
     type: string

diff --git a/modules/my_health/spec/request/v1/threads_request_spec.rb b/modules/my_health/spec/request/v1/threads_request_spec.rb
@@ -43,7 +43,10 @@
     let(:mhv_account_type) { 'Premium' }
 
     context 'not a va patient' do
-      before { get "/my_health/v1/messaging/folders/#{inbox_id}/threads" }
+      before do
+        get "/my_health/v1/messaging/folders/#{inbox_id}/threads",
+            params: { page_size: '5', page_number: '1', sort_field: 'SENDER_NAME', sort_order: 'ASC' }
+      end
 
       let(:va_patient) { false }
       let(:current_user) do
@@ -58,7 +61,7 @@
         it 'responds to GET #index' do
           VCR.use_cassette('sm_client/threads/gets_threads_in_a_folder') do
             get "/my_health/v1/messaging/folders/#{inbox_id}/threads",
-                params: { page_start: '1', page_end: '5', sort_field: 'SENDER_NAME', sort_order: 'ASC' }
+                params: { page_size: '5', page_number: '1', sort_field: 'SENDER_NAME', sort_order: 'ASC' }
           end
 
           expect(response).to be_successful
@@ -69,7 +72,7 @@
         it 'responds to GET #index when camel-inflected' do
           VCR.use_cassette('sm_client/threads/gets_threads_in_a_folder_camel') do
             get "/my_health/v1/messaging/folders/#{inbox_id}/threads",
-                params: { page_start: '1', page_end: '5', sort_field: 'SENDER_NAME', sort_order: 'ASC' },
+                params: { page_size: '5', page_number: '1', sort_field: 'SENDER_NAME', sort_order: 'ASC' },
                 headers: { 'X-Key-Inflection' => 'camel' }
           end
 

diff --git a/spec/support/schemas/message_threads.json b/spec/support/schemas/message_threads.json
@@ -46,7 +46,7 @@
                   "COVID",
                   "APPOINTMENTS",
                   "MEDICATIONS",
-                  "TEST_RESULTS",
+                  "TEST_RESULT",
                   "EDUCATION"
                 ]
               },

diff --git a/spec/support/schemas_camelized/message_threads.json b/spec/support/schemas_camelized/message_threads.json
@@ -46,7 +46,7 @@
                   "COVID",
                   "APPOINTMENTS",
                   "MEDICATIONS",
-                  "TEST_RESULTS",
+                  "TEST_RESULT",
                   "EDUCATION"
                 ]
               },

diff --git a/spec/support/vcr_cassettes/sm_client/threads/gets_threads_in_a_folder.yml b/spec/support/vcr_cassettes/sm_client/threads/gets_threads_in_a_folder.yml