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

feat(java): Allow overrides of Configuration #7

Closed
wants to merge 5 commits into from

Conversation

booniepepper
Copy link
Contributor

@booniepepper booniepepper commented Aug 21, 2023

Description

Most changes here can be seen in OpenFgaApi.java

References

Generated by openfga/sdk-generator#189

Review Checklist

  • I have clicked on "allow edits by maintainers".
  • I have added documentation for new/changed functionality in this PR or in a PR to openfga.dev [Provide a link to any relevant PRs in the references section above]
  • The correct base branch is being used, if not main
  • I have added tests to validate that the change in functionality is working as expected

@booniepepper booniepepper requested a review from a team as a code owner August 21, 2023 23:56
@booniepepper booniepepper marked this pull request as draft August 22, 2023 00:01
* @param storeId (required)
* @param body (required)
* @param configurationOverride Override the {@link Configuration} this OpenFgaApi was constructed with
* @return CompletableFuture<CheckResponse>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks a bit funny

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Javadocs use html escapes so &lt; is an escaped < -- it also allows some html tags like <code> but the rules are not exactly the same as HTML. There are also some custom {@<ident> <content>} Javadoc tags.

This renders correctly for the viewer:

Screenshot 2023-08-23 at 12-40-53 OpenFgaApi (openfga-sdk 0 1 API)

But taking a look at the JavaDocs, there's also a mess of unrendered markdown in some descriptions

Maybe it's worth an issue to update all the things. Maybe it's as simple as pandoc from commonmark to html for the descriptions, and doing some html unescaping. This is in a lot of the generated files

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Opened this issue, I think I'd rather it was all addressed together, and avoid letting it get inconsistent right now

openfga/sdk-generator#190

@rhamzeh rhamzeh deleted the feat/java-sdk-config-overrides branch September 8, 2023 15:00
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

Successfully merging this pull request may close these issues.

3 participants