Uploaded image for project: 'OpenAM'
  1. OpenAM
  2. OPENAM-14602

The API documentation for some Node API is missing methods/fields in 6.5/7

    Details

    • Type: Bug
    • Status: Open
    • Priority: Major
    • Resolution: Unresolved
    • Affects Version/s: 6.5.0, 6.5.0.1, 7.0.0
    • Fix Version/s: None
    • Labels:
    • Support Ticket IDs:

      Description

      Bug description

      For the TreeContext and the ExternalRequestContext documentation, the parts related to accessing Node headers and context is no longer available in 6.5 documentation. If with only this information, one will wonder how does get request headers and other contextual state that's publicly documented.

      See https://backstage.forgerock.com/docs/am/6.5/apidocs/org/forgerock/openam/auth/node/api/ExternalRequestContext.html

      and compare with

      https://backstage.forgerock.com/docs/am/6/apidocs/org/forgerock/openam/auth/node/api/ExternalRequestContext.html

      This goes for some other public classes mentioned like TreeContext.

      How to reproduce the issue

      1. See the above URL and compare.
      Expected behaviour
      The documentation should provide correct information
      
      Current behaviour
      Missing information.
      

      Work around

      The methods and fields is still there.

      Code analysis

      -

        Attachments

          Activity

            People

            • Assignee:
              Unassigned
              Reporter:
              chee-weng.chea C-Weng C
            • Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

              • Created:
                Updated: