Skip to content

[fix][doc] Stablize swagger docs - #19025

Merged
tisonkun merged 2 commits into
apache:masterfrom
tisonkun:stablize-swagger-docs
Dec 26, 2022
Merged

[fix][doc] Stablize swagger docs#19025
tisonkun merged 2 commits into
apache:masterfrom
tisonkun:stablize-swagger-docs

Conversation

@tisonkun

Copy link
Copy Markdown
Member

This fixes #18947. As a workaround.

It's not a regression because we cannot doc both endpoint right now.

Does this pull request potentially affect one of the following parts:

If the box was checked, please highlight the changes

  • Dependencies (add or upgrade a dependency)
  • The public API
  • The schema
  • The default values of configurations
  • The threading model
  • The binary protocol
  • The REST endpoints
  • The admin CLI options
  • The metrics
  • Anything that affects deployment

Documentation

  • doc
  • doc-required
  • doc-not-needed
  • doc-complete

Matching PR in forked repository

PR in forked repository:

Signed-off-by: tison <wander4096@gmail.com>
@tisonkun tisonkun self-assigned this Dec 22, 2022
@github-actions github-actions Bot added the doc Your PR contains doc changes, no matter whether the changes are in markdown or code files. label Dec 22, 2022
@codecov-commenter

codecov-commenter commented Dec 22, 2022

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 76.92308% with 3 lines in your changes missing coverage. Please review.
✅ Project coverage is 46.94%. Comparing base (08591d9) to head (b0f9f2f).
⚠️ Report is 3083 commits behind head on master.

Files with missing lines Patch % Lines
...he/pulsar/broker/admin/v2/PersistentTopicsExt.java 76.92% 3 Missing ⚠️
Additional details and impacted files

Impacted file tree graph

@@             Coverage Diff              @@
##             master   #19025      +/-   ##
============================================
- Coverage     49.85%   46.94%   -2.92%     
- Complexity     8658    10583    +1925     
============================================
  Files           500      710     +210     
  Lines         54930    69425   +14495     
  Branches       5867     7448    +1581     
============================================
+ Hits          27386    32590    +5204     
- Misses        24464    33182    +8718     
- Partials       3080     3653     +573     
Flag Coverage Δ
unittests 46.94% <76.92%> (-2.92%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines Coverage Δ
...pache/pulsar/broker/admin/v2/PersistentTopics.java 74.26% <ø> (+2.57%) ⬆️
...he/pulsar/broker/admin/v2/PersistentTopicsExt.java 76.92% <76.92%> (ø)

... and 264 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@tisonkun

This comment was marked as outdated.

@tisonkun tisonkun closed this Dec 22, 2022
@tisonkun
tisonkun deleted the stablize-swagger-docs branch December 22, 2022 05:31
Signed-off-by: tison <wander4096@gmail.com>
@tisonkun tisonkun reopened this Dec 22, 2022
@tisonkun

tisonkun commented Dec 22, 2022

Copy link
Copy Markdown
Member Author

Try explicit excluding by not included.

@tisonkun

Copy link
Copy Markdown
Member Author

OWASP failed on other dependencies that we should handle in different PRs:

debezium-connector-mysql-1.9.7.Final.jar: CVE-2017-15945(7.8)
Error:  debezium-connector-postgres-1.9.7.Final.jar: CVE-2019-10210(7.0), CVE-2019-10211(9.8), CVE-2015-3[16](https://github.com/apache/pulsar/actions/runs/3755293586/jobs/6384632023#step:10:17)7(7.5), CVE-2015-3166(9.8), CVE-2016-0768(7.5), CVE-2016-0766(8.8), CVE-2016-7048(8.1), CVE-2018-1115(9.1), CVE-2015-0243(8.8), CVE-2015-0244(9.8), CVE-2015-0241(8.8), CVE-2015-0242(8.8), CVE-2019-10128(7.8), CVE-2019-10127(8.8), CVE-2020-25694(8.1), CVE-2016-0773(7.5), CVE-2016-5424(7.1), CVE-2016-5423(8.3), CVE-2020-25695(8.8), CVE-2017-14798(7.0), CVE-2017-7484(7.5), CVE-2021-23214(8.1)
Error:  msgpack-core-0.9.0.jar: CVE-2022-4[17](https://github.com/apache/pulsar/actions/runs/3755293586/jobs/6384632023#step:10:18)19(7.5)
Error:  mysql-binlog-connector-java-0.27.2.jar: CVE-2017-15945(7.8)
Error:  snakeyaml-1.32.jar: CVE-2022-1471(9.8)
Error:  woodstox-core-6.2.4.jar: CVE-[20](https://github.com/apache/pulsar/actions/runs/3755293586/jobs/6384632023#step:10:21)22-40152(7.5)

@yuruguo yuruguo left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM

@tuteng tuteng left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM
I didn't find a better fix than this, so approved it

@tisonkun

Copy link
Copy Markdown
Member Author

Thanks for your reviews! Merging...

@tisonkun
tisonkun merged commit 63bf0ab into apache:master Dec 26, 2022
tisonkun added a commit to tisonkun/pulsar that referenced this pull request Dec 27, 2022
Signed-off-by: tison <wander4096@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc Your PR contains doc changes, no matter whether the changes are in markdown or code files. ready-to-test

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Unstable swagger output

4 participants