Uploaded image for project: 'UX Product'
  1. UX Product
  2. UXPROD-1414

Complete the documentation of data attributes in module APIs

    XMLWordPrintable

Details

    • Prokopovych
    • 120.1
    • R2
    • R1
    • R1
    • R2
    • R1
    • R1
    • R2
    • R1
    • R1
    • R1
    • R1

    Description

      Complete documentation of data attributes in Folio module APIs is needed to enable data modeling work as part of building reporting functionality. In particular, this is needed to ensure data quality for reporting.

      The specific documentation requirements being requested are described in: https://issues.folio.org/browse/FOLIO-1551

      This issue is a blocker for the entire Library Data Platform reference implementation epic ( https://issues.folio.org/browse/UXPROD-1128 ) . We may be able to develop somewhat in parallel; however, most of the documentation will be needed early in the reporting development because data models, ETL, and report queries all depend on it.

      TestRail: Results

        Attachments

          Issue Links

            blocks

            New Feature - New feature requests UXPROD-1438 Implement a process for tracking data-related API schema changes

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

            Task - A task that needs to be done. CIRCSTORE-144 Missing or incomplete documentation of data attributes in mod-circulation-storage

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

            Task - A task that needs to be done. MODUSERS-119 Missing or incomplete documentation of data attributes in mod-users

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

            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

            Task - A task that needs to be done. MODGQL-119 Investigate keeping JSON Schema link annotations separate

            • 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-203 Use description fields in JSON schemas

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

            Activity

              People

                Unassigned Unassigned
                nassar Nassib Nassar
                Votes:
                0 Vote for this issue
                Watchers:
                7 Start watching this issue

                Dates

                  Created:
                  Updated:
                  Resolved:

                  TestRail: Runs

                    TestRail: Cases