feat: document new response messages (#165)

Co-authored-by: Sonali Tanavade <sonali.tanavade@acrolinx.com>
acrolinx · Sep 4, 2024 · 39ad816 · 39ad816
1 parent 322499e
commit 39ad816
Showing 1 changed file with 84 additions and 0 deletions.
diff --git a/apiary.apib b/apiary.apib
@@ -7190,6 +7190,34 @@ Download check data as a CSV file
         "4265b702-9a69-38ca-bb45-bcad9ee7d910",2024-01-14T23:06:58Z,en,"api/v1/checking/scorecards/4265b702-9a69-38ca-bb45-bcad9ee7d910","9d38800b-89ae-396c-ae11-1de419f13a8f",Yak-1,,Yak-1,,35,red,20,1119,47,"Essentials English 2","2bd7dbcb-5510-4cdf-b054-0f275d3047c2",,,"96e79a50-97f9-3721-a755-0e9616c26a0b","AbcFull XyzName",webchecker,v1,"f5b8573c-e603-46d7-8af0-512d199d478b",developers,junior,draft,57,6,76,40,19,45,42,0,3,2,8,2,5,5,3,7
         "0521406f-ccf1-3acf-904a-7452766df8d7",2024-01-15T05:34:06Z,en,"api/v1/checking/scorecards/0521406f-ccf1-3acf-904a-7452766df8d7","77ad4993-80f1-31ec-9aef-1a33d2021a86",Su-22,,Su-22,,52,yellow,20,504,41,"Essentials English 2","2bd7dbcb-5510-4cdf-b054-0f275d3047c2","710eed98-732b-3668-8a67-f4294d9a7ff4",Wade,"96e79a50-97f9-3721-a755-0e9616c26a0b","AbcFull XyzName",webchecker,v1,"f5b8573c-e603-46d7-8af0-512d199d478b",developers,senior,draft,15,64,84,42,43,30,85,56,4,2,6,6,3,0,9,4
 
++ Response 400 (application/json)
+
+        {
+            "code": 400,
+            "message": "Provide a start date."
+        } 
+
++ Response 400 (application/json)
+
+        {
+            "code": 400,
+            "message": "Provide an end date."
+        } 
+
++ Response 400 (application/json)
+
+        {
+            "code": 400,
+            "message": "Provide a valid calendar date as the start date 2024-06-31.  For example, make sure the date entered corresponds with the actual number of days in the month."
+        } 
+
++ Response 400 (application/json)
+
+        {
+            "code": 400,
+            "message": "Provide a valid calendar date as the end date 2024-06-31.  For example, make sure the date entered corresponds with the actual number of days in the month."
+        } 
+
 + Response 400 (application/json)
 
         {
@@ -7204,6 +7232,20 @@ Download check data as a CSV file
             "message": "Invalid 'end' date 2024-08-28. The 'end' date must be before 2024-08-28. The most recent data available for download is from yesterday."
         } 
 
++ Response 400 (application/json)
+
+        {
+            "code": 400,
+            "message": "You can only download data from the past 12 months. Provide a different start date."
+        } 
+
++ Response 400 (application/json)
+
+        {
+            "code": 400,
+            "message": You can only download 30 days of data at a time. Adjust the date range."
+        } 
+
 + Response 401 (application/json)
 
         {
@@ -7318,6 +7360,34 @@ Download issues found as a CSV file
         "4bbdc491-6821-3b53-8881-001553987b69",2023-10-29,"hello woorld",woorld,sentence,"en_CONSISTENCY_Guideline_id-9","CONSISTENCY guideline id 9 display name",en,syntax
         "4bbdc491-6821-3b53-8881-001553987b69",2023-10-29,"hello woorld",woorld,sentence,"en_CONSISTENCY_Guideline_id-2","CONSISTENCY guideline id 2 display name",en,syntax
 
++ Response 400 (application/json)
+
+        {
+            "code": 400,
+            "message": "Provide a start date."
+        } 
+
++ Response 400 (application/json)
+
+        {
+            "code": 400,
+            "message": "Provide an end date."
+        } 
+
++ Response 400 (application/json)
+
+        {
+            "code": 400,
+            "message": "Provide a valid calendar date as the start date 2024-06-31.  For example, make sure the date entered corresponds with the actual number of days in the month."
+        } 
+
++ Response 400 (application/json)
+
+        {
+            "code": 400,
+            "message": "Provide a valid calendar date as the end date 2024-06-31.  For example, make sure the date entered corresponds with the actual number of days in the month."
+        } 
+
 + Response 400 (application/json)
 
         {
@@ -7332,6 +7402,20 @@ Download issues found as a CSV file
             "message": "Invalid 'end' date 2024-08-28. The 'end' date must be before 2024-08-28. The most recent data available for download is from yesterday."
         } 
 
++ Response 400 (application/json)
+
+        {
+            "code": 400,
+            "message": "You can only download data from the past 12 months. Provide a different start date."
+        } 
+
++ Response 400 (application/json)
+
+        {
+            "code": 400,
+            "message": You can only download 30 days of data at a time. Adjust the date range."
+        } 
+
 + Response 401 (application/json)
 
         {