Skip to content

[rest] Fix content-security-policy violation issue on RestCatalog API #5340

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

Merged
JingsongLi merged 4 commits into from
Mar 25, 2025
Merged

[rest] Fix content-security-policy violation issue on RestCatalog API #5340

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
739c29c
[rest] Fix content-security-policy violation issue on RestCatalog API
liyubin117 Mar 25, 2025
f8f4a7d
disable-search to avoid violation
liyubin117 Mar 25, 2025
be66d7a
add license
liyubin117 Mar 25, 2025
6fe06cd
update license & use `{{.Site.BaseURL}}` instead of path
liyubin117 Mar 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions LICENSE
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -297,6 +297,7 @@ MIT License

docs/assets/github.css (css generated by Hugo) from https://github.com/alecthomas/chroma version 2
docs/static/js/anchor.min.js from https://github.com/bryanbraun/anchorjs version 5.0
docs/static/js/redoc.standalone.js from https://github.com/Redocly/redoc version 2.0.0
Copy link
Copy Markdown
Contributor

@JingsongLi JingsongLi Mar 25, 2025

Choose a reason for hiding this comment

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

We should add its license to licenses directory.

Copy link
Copy Markdown
Contributor Author

@liyubin117 liyubin117 Mar 25, 2025

Choose a reason for hiding this comment

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

Got it!


BSD License
------------
Expand Down
9 changes: 7 additions & 2 deletions docs/content/concepts/rest/rest-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,11 @@ under the License.
-->

<body>
<redoc spec-url="https://raw.githubusercontent.com/apache/paimon/master/paimon-open-api/rest-catalog-open-api.yaml"></redoc>
<script src="https://cdn.jsdelivr.net/npm/redoc@next/bundles/redoc.standalone.js"></script>
<div id="redoc-container"></div>
<script src="/docs/master/js/redoc.standalone.js"></script>
Copy link
Copy Markdown
Contributor

@JingsongLi JingsongLi Mar 25, 2025

Choose a reason for hiding this comment

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

Refer it just like "{{.Site.BaseURL}}/js/flink.js"?

Copy link
Copy Markdown
Contributor Author

@liyubin117 liyubin117 Mar 25, 2025

Choose a reason for hiding this comment

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

After setting <script src="{{.Site.BaseURL}}/js/redoc.standalone.js"></script>, throw following error:

GET http://localhost:1313/docs/master/concepts/rest/rest-api/%7B%7B.Site.BaseURL%7D%7D/js/redoc.standalone.js net::ERR_ABORTED 404 (Not Found)

Copy link
Copy Markdown
Contributor

@JingsongLi JingsongLi Mar 25, 2025

Choose a reason for hiding this comment

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

Maybe add this <script to head.html, and this file just refer js function?

Copy link
Copy Markdown
Contributor Author

@liyubin117 liyubin117 Mar 25, 2025

Choose a reason for hiding this comment

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

Good idea~

<script>
Redoc.init('https://raw.githubusercontent.com/apache/paimon/master/paimon-open-api/rest-catalog-open-api.yaml', {
disableSearch: true
}, document.getElementById('redoc-container'));
</script>
</body>
1,829 changes: 1,829 additions & 0 deletions docs/static/js/redoc.standalone.js
View file
Open in desktop

Large diffs are not rendered by default.

21 changes: 21 additions & 0 deletions licenses/LICENSE.redoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
The MIT License (MIT)
Copy link
Copy Markdown
Contributor

@JingsongLi JingsongLi Mar 25, 2025

Choose a reason for hiding this comment

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

This file should be https://cdn.jsdelivr.net/npm/redoc@2.0.0-rc.75/bundles/redoc.standalone.js.LICENSE.txt

Copy link
Copy Markdown
Contributor Author

@liyubin117 liyubin117 Mar 25, 2025

Choose a reason for hiding this comment

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

Got it


Copyright (c) 2015-present, Rebilly, Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
1 change: 1 addition & 0 deletions pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -522,6 +522,7 @@ under the License.
<exclude>docs/themes/book/**</exclude>
<exclude>docs/assets/github.css</exclude>
<exclude>docs/static/js/anchor.min.js</exclude>
<exclude>docs/static/js/redoc.standalone.js</exclude>
<exclude>**/*.svg</exclude>
<exclude>**/dependency-reduced-pom.xml</exclude>
<!-- Bundled license files -->
Expand Down
Loading