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

Improve oidcProviders API fields' description

XMLWordPrintable

    • Icon: Bug Bug
    • Resolution: Unresolved
    • Icon: Minor Minor
    • None
    • 4.20
    • apiserver-auth
    • None
    • Quality / Stability / Reliability
    • False
    • Hide

      None

      Show
      None
    • None
    • Low
    • None
    • None
    • None
    • None
    • None
    • None
    • None
    • None
    • None
    • None
    • None
    • None

      Description of problem:

      `oc explain authentication.xxx.xxx` does not give good enough description for some fields as below related to external oidc config. Using this Jira to track improvement.
      

      Version-Release number of selected component (if applicable):

      Any
      

      How reproducible:

      Always
      

      Steps to Reproduce:

      1. $ oc explain authentication.spec.oidcProviders.oidcClients
      ...
          componentNamespace is the namespace of the component that is supposed to
          consume this
          client configuration
      ...
      2. $ oc explain authentication.spec.oidcProviders.issuer.audiences
      ...
          Must be set to exactly one value.
      ...
      3. $ oc explain authentication.spec.oidcProviders.issuer
          issuer describes atributes ...
      

      Actual results:

      1 "consume this" and "client configuration" display in two lines.
      2 "Must be set to exactly one value" is confusing. We can set multiple values as audiences.
      3. "atributes" is a typo
      

      Expected results:

      1. Display in one line
      2. Remove "Must be set to exactly one value"
      3. Correct the typo
      

      Additional info:
      Thanks rhn-support-ahoffer for raising 2 and 3

              Unassigned Unassigned
              xxia-1 Xingxing Xia
              None
              None
              Xingxing Xia Xingxing Xia
              None
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

                Created:
                Updated: