Uploaded image for project: 'mod-vendors'
  1. mod-vendors
  2. MODVEND-81

Load sample data via tenant API

    XMLWordPrintable

    Details

    • Type: Story
    • Status: Closed (View Workflow)
    • Priority: P3
    • Resolution: Done
    • Affects Version/s: None
    • Fix Version/s: 2.1.0
    • Labels:
      None
    • Template:
    • Sprint:
      ACQ Sprint 59
    • Story Points:
      3
    • Development Team:
      Thunderjet

      Description

      In a recent discussion we've decided to pursue a different approach to loading sample data which involves overriding the default implementation of the tenant interface (POST _/tenant). This API is called by OKAPI when the module is enabled for a tenant.

      Basic approach:

      • Execute the standard/default logic
      • Look for one or more request parameters indicating whether or not to load sample and/or reference data. These parameters are specified in the tenantAttribute data.
      • Conditionally read in data (from somewhere) and make appropriate API calls to insert the data
      • The case of upgrades should be handled appropriately, e.g. if an upgrade and the data already exists, perform a PUT, otherwise, a POST will suffice.

      This basic approach has been implemented for orders storage. See https://issues.folio.org/browse/MODORDSTOR-48. Much of this implementation can likely be borrowed.

      Special sauce:

      • Define system properties or module arguments which would be specified at runtime indicating whether or not to load sample and reference data. This would dictate the default behavior in the case where the aforementioned flags aren't specified by OKAPI when calling the tenant API. Note that these would be applied to ALL tenants, whereas the params provided by OKAPI would be tenant specific.

      See related stories for additional details.

      Additional context:

      https://github.com/folio-org/okapi/blob/master/doc/guide.md#install-operation-example
      https://github.com/folio-org/okapi/blob/master/doc/guide.md#tenant-parameters

      Testing steps:

      • Run attached script to get all vendor records from folio-snapshot
      • At least 13 vendor records will be returned

        TestRail: Results

          Attachments

            Issue Links

              Activity

                People

                Assignee:
                cmcnally Craig McNally
                Reporter:
                cmcnally Craig McNally
                Tester Assignee:
                Craig McNally Craig McNally
                Votes:
                0 Vote for this issue
                Watchers:
                5 Start watching this issue

                  Dates

                  Created:
                  Updated:
                  Resolved:

                    TestRail: Runs

                      TestRail: Cases