Update openapi_extraction.yml

sensible-hq · Aug 28, 2023 · 1af517d · 1af517d
1 parent 47abb74
commit 1af517d
Showing 1 changed file with 5 additions and 8 deletions.
diff --git a/openapi_extraction.yml b/openapi_extraction.yml
@@ -556,7 +556,7 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/StatisticsResponse'
-          description: Returns daily statistics for each config in the specified time period. TODO correct?
+          description: Returns daily statistics for configs in the specified time period.
         '401':
           $ref: '#/components/responses/401'
         '400':
@@ -963,9 +963,10 @@ components:
         document_type_name:
           $ref: '#/components/schemas/DocumentTypeName'
         quality_score_histogram:
-          description: >-
+          description: |
             Array of integers that describe the number of extractions that fell into each quality bucket for the `date` for this config.
             The buckets are as follows:
+
             - [0, 10)
             - [10, 20)
             - [20, 30)
@@ -982,13 +983,9 @@ components:
             `[` denotes inclusive and `)` denotes exclusive.
             For example, when this endpoint returns `"quality_score_histogram":[7,5,3,3,2,1,1,4,7,9,13,15]` , the first and last items in the array show that on specified date for the specified config, 7 extractions scored in the lowest quality bucket of 0-10%, and 15 scored in the highest quality bucket of 100%.
              For more information about quality scores, see [Accuracy measures](doc:accuracy-measures).
-             From the payload returned by this endpoint, you can calculate other metrics or view them in the Sensible app, for example:
+             From the payload returned by this endpoint, you can calculate other metrics, for example:
               - total number of extractions in a time period
-              - doc type and config usage (# of relevant extractions / total extractions) TODO REWORD
-              - daily stats (i.e. the API extractions graph with specific totals per day)
-              - Configs require attention  TODO REWORD
-             TODO update link if necessary (accurayc measures)
-             TODO: add new endpoints to the Introduction topic
+              - doc type and config usage
           type: array
           example: [1,3,5,4,6,5,3,7,8,2,4,9]
           items: