-
Bug
-
Resolution: Fixed
-
Low (View bug fix roadmap)
-
None
NOTE: This bug report is for JIRA Server. Using JIRA Cloud? See the corresponding bug report.
There is a documentation issue at https://developer.atlassian.com/static/javadoc/applinks/3.6.1/reference/com/atlassian/applinks/core/rest/package-summary.html
The documentation for EntityResource states:
This service has two responsibilities:
1. Returning a list of entities local to this instance that are accessible to the logged in user.
It is missing the second number point below
This service has two responsibilities:
1. Returning a list of entities local to this instance that are accessible to the logged in user.
2. Proxying the above method from a corresponding EntityResource in a remote application instance (allowing local views to retrieve lists of remote entities)
- relates to
-
-
- Closed
-
[JRASERVER-36635] Request for EntityResource documentation update
I have a change underway to update the javadoc of this class in applinks so the class summary makes sense in a single paragraph.
Having said this, the "pretty" javadoc available at developer.atlassian.com will not be fixed until applinks starts generating pretty docs for newer versions and upload them to developer.atlassian.com, so we can actually federate JIRA's pretty docs against the "pretty" docs for the correct version of applinks (the one we actually bundle).
At the moment JIRA 6.1.x is bundling applinks 4.1.x and master is bundling 4.2.0, I will raise separate issues to track this work.
The documentation update has been merged to all applinks branches and should be available as soon as we release a new version of applinks.