dimas-b opened a new pull request, #401:
URL: https://github.com/apache/polaris/pull/401
Apparently the OpenAPI generator is not escating `<` chars in javadoc
property, which leads to commpilation warnings and actually invalid rendering
of the affected javadoc.
```
> 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>\".
```
It seems easiest to fix the corresponding comment in the Open API yaml file
and avoid using `<` there.
# Description
Please include a summary of the changes and the related issue. Please also
include relevant motivation and context. List any dependencies that are
required for this change.
Fixes # (issue)
## Type of change
Please delete options that are not relevant.
- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] Documentation update
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing
functionality to not work as expected)
- [ ] This change requires a documentation update
# How Has This Been Tested?
Please describe the tests that you ran to verify your changes. Provide
instructions so we can reproduce. Please also list any relevant details for
your test configuration
- [ ] Test A
- [ ] Test B
**Test Configuration**:
* Hardware:
* Toolchain:
* SDK:
# Checklist:
Please delete options that are not relevant.
- [ ] I have performed a self-review of my code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation
- [ ] My changes generate no new warnings
- [ ] If adding new functionality, I have discussed my implementation with
the community using the linked GitHub issue
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
