Uploaded image for project: 'FOLIO'
  1. FOLIO
  2. FOLIO-1736

SPIKE: When used by clients, JSON schemas with "additionalProperties: false" fail on optional properties

    XMLWordPrintable

Details

    • CP: ready for planning
    • 3
    • Core: Platform

    Description

      Problem:

      When a new optional property is added to the JSON Schema that describes a server-side entity we assume backwards compatibility (minor version increment).

      However, if the very same JSON Schema definition file is used by the client the deserialization will fail due to the fact that FOLIO schemas include additionalProperties: false setting.

      There is a mismatch here that needs to be addressed, some potential approaches include:

      • change versioning policy so that even optional properties are considered breaking changes
      • keep separate versions of schemas between servers and clients with the client version being more relaxed
      • override "additionalProperties: false" when any given schema is used in the client context

      We need to decide on the approach and document it on dev.folio.org

      TestRail: Results

        Attachments

          Issue Links

            relates to

            Task - A task that needs to be done. FOLIO-1718 extending guidelines on versioning

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

            Bug - A problem which impairs or prevents the functions of the product. FOLIO-1735 Unable to login due to unrecognised staffSlips property when deserialising a service point

            • P1 - highest priority item, drop everything else before this is resolved, reserved for critical bugfixes
            • Closed

            Bug - A problem which impairs or prevents the functions of the product. MODUSERBL-64 Add staffSlips array to servicepoint.json

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

            Bug - A problem which impairs or prevents the functions of the product. MODUSERBL-65 Cannot login when additional properties are provided for service points

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

            Bug - A problem which impairs or prevents the functions of the product. MODUSERBL-89 Unrecognized field "customFields" (class org.folio.rest.jaxrs.model.User)

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

            Activity

              People

                Unassigned Unassigned
                jakub Jakub Skoczen
                Votes:
                0 Vote for this issue
                Watchers:
                3 Start watching this issue

                Dates

                  Created:
                  Updated:
                  Resolved:

                  TestRail: Runs

                    TestRail: Cases