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

Use description fields in JSON schemas

    XMLWordPrintable

Details

    • Task
    • Status: Closed (View Workflow)
    • P3
    • Resolution: Done
    • None
    • 18.0.0
    • Core: Platform

    Description

      Purpose: Supply descriptions in RAML and JSON schema.

      These descriptions are useful documentation and are particularly useful for people getting familiar with a module, for example in planning data migration:

      1. https://github.com/folio-org/mod-inventory-storage/edit/master/ramls/instance.json
      2. https://github.com/folio-org/mod-inventory-storage/edit/master/ramls/holdingsrecord.json
      3. https://github.com/folio-org/mod-inventory-storage/edit/master/ramls/item.json

      TestRail: Results

        Attachments

          Issue Links

            relates to

            Umbrella - FOLIO-1551 Missing or incomplete documentation of data attributes in many module APIs

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

            Task - A task that needs to be done. MODINVSTOR-244 Add missing JSON object descriptions

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

            New Feature - New feature requests FOLIO-1447 FOLIO policy for RAML and JSON descriptions

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

            New Feature - New feature requests UXPROD-1414 Complete the documentation of data attributes in module APIs

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

            Activity

              People

                fhemme Felix Hemme
                dcrossley David Crossley
                Votes:
                0 Vote for this issue
                Watchers:
                5 Start watching this issue

                Dates

                  Created:
                  Updated:
                  Resolved:

                  TestRail: Runs

                    TestRail: Cases