Uploaded image for project: 'mod-inventory-storage'
  1. mod-inventory-storage
  2. MODINVSTOR-438

stream GET for /instance, /holdings and /items

    XMLWordPrintable

Details

    • CP: sprint 82, CP: sprint 83
    • Core: Platform

    Description

      The existing endpoints;

      /instance-storage/instances https://github.com/folio-org/mod-inventory-storage/blob/master/ramls/instances.json
      /holdings-storage/holdings https://github.com/folio-org/mod-inventory-storage/blob/master/ramls/holdingsrecords.json
      /item-storage/items https://github.com/folio-org/mod-inventory-storage/blob/master/ramls/items.json

      will be refactored to use the streaming utility developed through RMB-559. The schema for those endpoints will be extended with a new optional field called resultInfo which uses the schema defined at:

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

      This is going to match response types in mod-users, e.g:

      https://github.com/folio-org/mod-users/blob/master/ramls/userdataCollection.json

      In case of errors, the stream will be immediately terminated and errors will be supplied in the trailing resultInfo section.

      TestRail: Results

        Attachments

          Issue Links

            has to be done after

            New Feature - New feature requests RMB-500 PostgresClient.streamGet with total hits and error handling

            • P2 - normal priority level, must be included in the current development cycle
            • Closed
            is blocked by

            New Feature - New feature requests RMB-559 Add stream get utility that produces HTTP result

            • P2 - normal priority level, must be included in the current development cycle
            • Closed
            relates to

            Bug - A problem which impairs or prevents the functions of the product. MODUSERS-170 queries with limit=2147483647 may return 500

            • P3 - low priority level, item will be considered for inclusion in the next dev cycle
            • Open

            Task - A task that needs to be done. MODCXINV-44 Upgrade to RMB 29

            • TBD - To be determined
            • Closed

            Story - Created by Jira Software - do not edit or delete. Issue type for a user story. MODINVSTOR-439 Create bulk download endpoint to save id UUIDs

            • P2 - normal priority level, must be included in the current development cycle
            • Closed

            Story - Created by Jira Software - do not edit or delete. Issue type for a user story. MODINVSTOR-452 Create size optimized bulk download endpoint to save id UUIDs

            • P3 - low priority level, item will be considered for inclusion in the next dev cycle
            • Open

            Task - A task that needs to be done. RMB-535 SPIKE allow module to set the maximum number of records that can be sent during a batch PUT/POST

            • P3 - low priority level, item will be considered for inclusion in the next dev cycle
            • Open

            Activity

              People

                adam Adam Dickmeiss (Inactive)
                adam Adam Dickmeiss (Inactive)
                Votes:
                0 Vote for this issue
                Watchers:
                2 Start watching this issue

                Dates

                  Created:
                  Updated:
                  Resolved:

                  TestRail: Runs

                    TestRail: Cases