Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Missing descriptions in for Fault Tolerance parameters #485

Closed
dmuelle opened this issue Dec 2, 2019 · 3 comments
Closed

Missing descriptions in for Fault Tolerance parameters #485

dmuelle opened this issue Dec 2, 2019 · 3 comments
Assignees
Milestone

Comments

@dmuelle
Copy link

dmuelle commented Dec 2, 2019

In the Open Liberty javadoc, a number of Fault Tolerance annotation parameters are missing descriptions in the autogen Optional Elements tables for each annotation. The descriptions are present in the element detail but missing from the table.

Circuit Breaker

delayUnit

Retry

delayUnit
durationUnit
jitterDelayUnit
retryOn

Timeout

unit

@Ladicek
Copy link
Contributor

Ladicek commented Dec 3, 2019

Should be filed in OpenLiberty bug tracker?

@Azquelt
Copy link
Member

Azquelt commented Dec 3, 2019

The issues with Retry and Timeout are also present in the javadoc on eclipse.org

Retry
Timeout

The issue with CircuitBreaker was fixed at some point between 2.0 and 2.0.1.

I think this happens when the annotation parameter just has an @return line and no other text.

I think the openliberty.io site just builds the javadocs based on the dependencies of the umbrella microprofile artifact, and that's still pulling in the 2.0 version of the API without the CircuitBreaker fix.

So, it might be good to raise an issue on the openliberty.io site to pull in the latest micro release of each spec, rather than the version in the umbrella artifact, but the javadoc for Retry and Timeout also need fixed here.

As a side note, it would be nice there was an easy to find official location of all the microprofile javadoc, (say, linked from microprofile.io) rather than having to fish around download.eclipse.org to find it.

@Emily-Jiang Emily-Jiang added this to the 2.1 milestone Dec 3, 2019
@Emily-Jiang
Copy link
Member

Let's fix in the spec. @Azquelt I have been working with @rstjames for the microprofile.io page redesign see microprofile/microprofile-site#87. Feel free to add any comments there.

@Emily-Jiang Emily-Jiang self-assigned this Jan 21, 2020
Emily-Jiang added a commit to Emily-Jiang/microprofile-fault-tolerance that referenced this issue Jan 21, 2020
Signed-off-by: Emily Jiang <[email protected]>
Emily-Jiang added a commit that referenced this issue Jan 21, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

5 participants