[OPENAM-14602] The API documentation for some Node API is missing methods/fields in 6.5/7 Created: 13/Mar/19  Updated: 18/Mar/19

Status: Open
Project: OpenAM
Component/s: API descriptor, authentication
Affects Version/s: 6.5.0, 6.5.0.1, 7.0.0
Fix Version/s: None

Type: Bug Priority: Major
Reporter: C-Weng C Assignee: Unassigned
Resolution: Unresolved Votes: 0
Labels: EDISON
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Rank: 1|hzxsqf:
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

-


Generated at Mon Mar 01 10:15:10 UTC 2021 using Jira 7.13.12#713012-sha1:6e07c38070d5191bbf7353952ed38f111754533a.