Api 33629 update bi docs (#16103)

* Updated BI docs with better words * more changes in BI md docs --------- Co-authored-by: Kristen Brown <11942904+kristen-brown@users.noreply.github.com>
department-of-veterans-affairs · Apr 11, 2024 · 727ef23 · 727ef23
1 parent 26ce195
commit 727ef23
Show file tree

Hide file tree

Showing 3 changed files with 187 additions and 187 deletions.
diff --git a/modules/vba_documents/app/swagger/vba_documents/v1/controller_swagger.rb b/modules/vba_documents/app/swagger/vba_documents/v1/controller_swagger.rb
@@ -85,6 +85,9 @@ class ControllerSwagger
           extend VBADocuments::Responses::ForbiddenError
           key :summary, 'Get status for a previous benefits document upload'
           key :operationId, 'getBenefitsDocumentUploadStatus'
+          key :description, 'A request to the `/uploads/{id}` endpoint will return a real-time status for that GUID, ' \
+                            'and update its status in `/uploads/report`.\n\n' \
+                            'The `updated_at` field indicates the last time the status for a given GUID was updated.'
 
           key :tags, [
             VBA_TAG
@@ -173,6 +176,12 @@ class ControllerSwagger
 
           key :summary, 'Get a bulk status report for a list of previous uploads'
           key :operationId, 'getBenefitsDocumentUploadStatusReport'
+          key :description, 'Due to current system limitations, data for the `/uploads/report` endpoint is cached for one hour.' \
+                            '\n\n' \
+                            'A request to the `/uploads/{id}` endpoint will return a real-time status for that GUID, ' \
+                            'and update its status in `/uploads/report`.' \
+                            '\n\n' \
+                            'The `updated_at` field indicates the last time the status for a given GUID was updated.'
 
           security do
             key :apikey, []