Uploaded image for project: 'Nuxeo Documentation'
  1. Nuxeo Documentation
  2. NXDOC-2069

Create Nuxeo Drive configuration validators

    XMLWordPrintable

    Details

    • Type: New Feature
    • Status: Open
    • Priority: Minor
    • Resolution: Unresolved
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: Nuxeo Drive

      Description

      The goal is to create validators for configuration files:

      • Local config uses INI data.
      • Server config uses JSON data.

      I do not yet know where to put this, but I would like to make validators available in the documentation:

      Results:

      • If there are errors: display them
      • If there is no error:
        • If there are parameters that use default values, warn the user.
        • Return the configuration contents well-formatted (see below).

      The validator will have to take care of parameter names: my-parameter, my_parameter or even MY-ParaMETER and they all are valid and referring to my-parameter.
      So when a configuration is valid, the tool should return normalized parameter names, alphabetically sorted and remove ones using default values.

      The validator will also ensure that the value entered is the same type of the one required. This is to prevent issues when one would use client_version = 4.4 (float) when client_version = "4.4.0" (string) is needed.

      I can provide a list of parameters and their values.

      Ideally, the server configuration validator would be located at https://doc.nuxeo.com/client-apps/how-to-configure-nuxeo-drive-globally/, and the local configuration validator at https://doc.nuxeo.com/client-apps/nuxeo-drive/#configuration-file.

        Attachments

          Activity

            People

            • Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

              • Created:
                Updated:

                Time Tracking

                Estimated:
                Original Estimate - Not Specified
                Not Specified
                Remaining:
                Remaining Estimate - 0 minutes
                0m
                Logged:
                Time Spent - 20 minutes
                20m