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

doc: add more details and examples to import openapi guide #1672

Merged
merged 8 commits into from
Apr 1, 2021

Conversation

liuxiran
Copy link
Contributor

@liuxiran liuxiran commented Mar 25, 2021

Please answer these questions before submitting a pull request, or your PR will get closed.

Why submit this pull request?

  • Bugfix
  • New feature provided
  • Improve performance
  • Backport patches

What changes will this PR take into?

improve IMPORT_OPENAPI_USER_GUIDE.md, add more details and examples to help users to import route from the correct OAS3.0 file.

Related issues

close #1464
close #1660

Checklist:

  • Did you explain what problem does this PR solve? Or what new features have been added?
  • Have you added corresponding test cases?
  • Have you modified the corresponding document?
  • Is this PR backward compatible? If it is not backward compatible, please discuss on the mailing list first

@codecov-io
Copy link

codecov-io commented Mar 25, 2021

Codecov Report

Merging #1672 (9a618cf) into master (c6c5d14) will decrease coverage by 5.58%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #1672      +/-   ##
==========================================
- Coverage   72.59%   67.00%   -5.59%     
==========================================
  Files         133       47      -86     
  Lines        5728     3116    -2612     
  Branches      666        0     -666     
==========================================
- Hits         4158     2088    -2070     
+ Misses       1327      776     -551     
- Partials      243      252       +9     
Flag Coverage Δ
backend-e2e-test 47.36% <ø> (-14.77%) ⬇️
backend-e2e-test-ginkgo ?
backend-unit-test 51.77% <ø> (-0.04%) ⬇️
frontend-e2e-test ?

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

Impacted Files Coverage Δ
...l/handler/route_online_debug/route_online_debug.go 5.55% <0.00%> (-70.38%) ⬇️
api/internal/handler/healthz/healthz.go 66.66% <0.00%> (-33.34%) ⬇️
api/internal/core/entity/entity.go 81.25% <0.00%> (-18.75%) ⬇️
api/internal/filter/schema.go 39.49% <0.00%> (-15.97%) ⬇️
api/internal/core/store/storehub.go 63.55% <0.00%> (-11.22%) ⬇️
api/internal/handler/schema/schema.go 90.47% <0.00%> (-9.53%) ⬇️
api/internal/handler/handler.go 68.51% <0.00%> (-9.26%) ⬇️
api/internal/handler/route/route.go 71.42% <0.00%> (-7.35%) ⬇️
api/internal/handler/ssl/ssl.go 67.53% <0.00%> (-5.76%) ⬇️
api/internal/filter/authentication.go 72.22% <0.00%> (-5.56%) ⬇️
... and 93 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update c6c5d14...9a618cf. Read the comment docs.

Copy link
Member

@nic-chen nic-chen left a comment

Choose a reason for hiding this comment

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

@liuxiran

thanks so much.

Need to add some instructions on importing duplicate data, as well as instructions on the status of the route after import.

@starsz
Copy link
Contributor

starsz commented Mar 28, 2021

@juzhiyuan @LiteSun Help check the Frontend CI.

@juzhiyuan
Copy link
Member

image

Hi, please first update the markdown

@juzhiyuan juzhiyuan requested a review from nic-chen March 29, 2021 15:04
Copy link
Member

@nic-chen nic-chen left a comment

Choose a reason for hiding this comment

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

LGTM from the content. Thanks @liuxiran

Copy link
Member

@juzhiyuan juzhiyuan left a comment

Choose a reason for hiding this comment

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

LGTM

@juzhiyuan juzhiyuan requested a review from imjoey March 31, 2021 06:30
Copy link
Member

@imjoey imjoey left a comment

Choose a reason for hiding this comment

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

/lgtm

@imjoey imjoey merged commit a409f75 into apache:master Apr 1, 2021
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.

doc: Improve docs about route import and export doc: improve documentation for route export and import
8 participants