Fix javadoc in OpenAPI generated code #401
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dimas-b
requested review from
jbonofre,
ashvina,
RussellSpitzer,
snazy,
vvcephei,
takidau,
jackye1995,
flyrain,
eric-maynard,
collado-mike and
ebyhr
as code owners
|
Can we consider instead making this fix in the upstream Iceberg spec? |
We should do that, otherwise, the issue will come back next time Polaris syncs the Iceberg rest spec. |
Fix the mustache pattern to do HTML escaping for special chars in javadoc (do not use tripple `{{{`).
Original warning:
```
> Task :polaris-service:javadoc
/home/.../polaris-service/build/generated/src/main/java/org/apache/polaris/service/catalog/api/IcebergRestCatalogApi.java:489: warning: invalid input: '<'
* Load a table from the catalog. The response contains both configuration and table metadata. The configuration, if non-empty is used as additional configuration for the table that overrides catalog configuration. For example, this configuration may change the FileIO implementation to be used for the table. The response also contains the table's full metadata, matching the table metadata JSON file. The catalog configuration may contain credentials that should be used for subsequent requests for the table. The configuration key \"token\" is used to pass an access token to be used as a bearer token for table requests. Otherwise, a token may be passed using a RFC 8693 token type as a configuration key. For example, \"urn:ietf:params:oauth:token-type:jwt=<JWT-token>\".
```
dimas-b
force-pushed
the
fix-javadoc-warn
branch
from
c38bcfb to
7951fad
Compare
|
Upstreaming is not necessary. The pattern turned out to be local to Polaris, but it was using the unescaped way of including "notes". |
This comment was marked as duplicate.
This comment was marked as duplicate.
Sorry, something went wrong.
eric-maynard
approved these changes
Oct 24, 2024
|
The PR description has been updated, indeed. |
|
Nice! I think since we aren't changing any javadoc anymore the title might still be misleading. Either way, LGTM |
|
Generated javadoc is changed by virtue of changing the pattern that generates it. |
collado-mike
approved these changes
Oct 24, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fix the mustache pattern to do HTML escaping for special chars in javadoc (do not use tripple
{{{).Original warning: