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.

Sign up for GitHub

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

Jump to bottom

Java SDK: Javadocs need love #190

Open
booniepepper opened this issue Aug 23, 2023 · 0 comments
Open

Java SDK: Javadocs need love #190

booniepepper opened this issue Aug 23, 2023 · 0 comments
Labels
java-sdk Affects the Java/Kotlin SDK

Comments

@booniepepper
Copy link
Contributor

There are some artifacts from OpenAPI generator like HTML escapes (especially < and > for generic tags) that seem unnecessary.

Comes from https://github.com/openfga/java-sdk/pull/7/files#r1303460515 and #189 (comment)

Also there are some descriptions in unrendered markdown that are hard to read.

One example:

Screenshot 2023-08-23 at 12-40-53 OpenFgaApi (openfga-sdk 0 1 API)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
java-sdk Affects the Java/Kotlin SDK
Projects
SDKs and Tooling
Status: Backlog
Milestone
No milestone
Development

No branches or pull requests
2 participants
@rhamzeh @booniepepper