Uploaded image for project: 'OpenShift Bugs'
  1. OpenShift Bugs
  2. OCPBUGS-44612

Plugin API: Inconsistent naming user preference / setting

XMLWordPrintable

    • Icon: Bug Bug
    • Resolution: Unresolved
    • Icon: Normal Normal
    • None
    • 4.18
    • Management Console
    • None
    • None
    • False
    • Hide

      None

      Show
      None

      Our plugin extension point uses the term "preference," but the SDK hook uses the term "setting" for user preference.

      https://github.com/openshift/console/blob/master/frontend/packages/console-dynamic-plugin-sdk/docs/console-extensions.md#consoleuser-preferencegroup

      https://github.com/openshift/console/blob/master/frontend/packages/console-dynamic-plugin-sdk/docs/api.md#useusersettings

      We should be consistent in our naming. Since we use the label "User Preferences" in the console, I'd suggest we deprecate useUserSettings and expose a useUserPreference API. (Since it returns a single value, we should probably also use the singular in the hook name.)

      cc jhadvig@redhat.com vszocs@redhat.com 

              jhadvig@redhat.com Jakub Hadvig
              spadgett@redhat.com Samuel Padgett
              YaDan Pei YaDan Pei
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Created:
                Updated: