Uploaded image for project: 'RAML Module Builder'
  1. RAML Module Builder
  2. RMB-578

Inform whether totalRecords is exact or an estimate

    XMLWordPrintable

    Details

    • Type: New Feature
    • Status: Blocked (View Workflow)
    • Priority: P2
    • Resolution: Unresolved
    • Affects Version/s: None
    • Fix Version/s: None
    • Template:
    • Sprint:
      CP: Non-roadmap backlog, CP: sprint 94, CP: sprint 95, CP: sprint 96, CP: sprint 97, CP: sprint 98, CP: sprint 99
    • Story Points:
      2
    • Development Team:
      Core: Platform

      Description

      Extend resultInfo.schema with a new property that indicates whether totalRecords is an estimate or exact.

      Possible property names:

      • "isTotalRecordsEstimate"
      • "totalRecordsEstimated"
      • "totalRecordsAreEstimated"

      Core platform team decided to pick "totalRecordsEstimated" on 2020-07-27.

      True means that "totalRecords" is an estimated number, false means that "totalRecords" is the exact number, if omitted the exact count guarantee described on https://github.com/folio-org/raml-module-builder#estimated-totalrecords applies.

      https://github.com/folio-org/raml/blob/raml1.0/schemas/resultInfo.schema

      Note: it seems more appropriate to add it to resultInfo ONCE rather than doing it at as top-level element in response for each module.

      Example where "totalRecordsEstimated" has been added:

      {
        "instances": [
          { "id": "bf8812c6-4a2f-44f0-ac1f-ba2424cea00a", ... },
          { "id": "bfcefc83-4a2f-44f0-ac1f-ba2424cea48a", ...}
        ],
        "totalRecords": 2,
        "resultInfo" : {
          "totalRecords" : 2,
          "totalRecordsEstimated": false,
          "facets" : [ ]
        }
      }
      

        TestRail: Results

          Attachments

            Issue Links

              Activity

                People

                Assignee:
                julianladisch Julian Ladisch
                Reporter:
                adam Adam Dickmeiss
                Votes:
                0 Vote for this issue
                Watchers:
                10 Start watching this issue

                  Dates

                  Created:
                  Updated:

                    TestRail: Runs

                      TestRail: Cases