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

feat(swagger): update to 5.1.0 swagger-ui [KHCP-10938] #1168

Merged
merged 24 commits into from
Mar 13, 2024

Conversation

davidma415
Copy link
Contributor

@davidma415 davidma415 commented Feb 20, 2024

Summary

https://konghq.atlassian.net/browse/KHCP-10938
A spike PR for updating to newest swagger-ui that supports openapi: 3.1.0.

Deploy Previews in consuming apps:

khcp-ui: https://pr-7710--khcp-ui.cloud-preview.konghq.tech/

konnect-ui-apps: https://pr-2591--api-products.cloud-preview.konghq.tech/api-products

konnect-portal: Kong/konnect-portal#459


Screenshot 2024-03-12 at 3 04 51 PM Screenshot 2024-03-05 at 12 57 26 PM Screenshot 2024-03-05 at 1 07 33 PM

@mptap mptap self-assigned this Mar 1, 2024
@mptap
Copy link
Contributor

mptap commented Mar 1, 2024

swagger UI styles working as expected without local import 🎉

Screenshot 2024-03-04 at 10 36 18 AM

@davidma415
Copy link
Contributor Author

If we just use swagger's styling
Screenshot 2024-03-04 at 7 11 23 AM

vs. this is how it is currently
Screenshot 2024-03-04 at 7 11 30 AM

I think we'd need design feedback on this, or atleast we should remove the background-color on the operation at the very least so it doesn't look too different than what it is now.

@mptap mptap changed the title DNM - feat(swagger): update to 5.1.0 swagger-ui feat(swagger): update to 5.1.0 swagger-ui [KHCP-10938] Mar 4, 2024
@mptap mptap removed the do not merge label Mar 4, 2024
@mptap mptap marked this pull request as draft March 4, 2024 18:35
@jillztom
Copy link
Collaborator

jillztom commented Mar 4, 2024

Screenshot 2024-03-04 at 1 54 46 PM

We might need to tweak this CSS as well

@mptap
Copy link
Contributor

mptap commented Mar 5, 2024

@jillztom > We might need to tweak this CSS as well
Now fixed.

Note this was occuring only in the sandbox, and not in the consuming apps, as they're using a custom style to override the background on hover. See ProductVersionDocumentation.vue in konnect-ui-apps

@mptap mptap marked this pull request as ready for review March 5, 2024 21:50
Copy link
Member

@adamdehaven adamdehaven left a comment

Choose a reason for hiding this comment

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

The section and text colors are not prefixed with kong-ui- in the codebase

@adamdehaven
Copy link
Member

The section and text colors are not prefixed with kong-ui- in the codebase

e.g. you should be using --text_colors-accent and --section_colors-accent etc.

@mptap
Copy link
Contributor

mptap commented Mar 8, 2024

The section and text colors are not prefixed with kong-ui- in the codebase

Yes, I'm using var(--text_colors-primary) but linter's unhappy so added a disable for that line.

kaiarrowood
kaiarrowood previously approved these changes Mar 12, 2024
Copy link
Contributor

@kaiarrowood kaiarrowood left a comment

Choose a reason for hiding this comment

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

LGTM! 🚀 nice work @mptap !

@davidma415
Copy link
Contributor Author

Looks good to me from the portal POV with respect to theming etc. 👍 great job, thanks for helping out with this!

@mptap mptap enabled auto-merge (squash) March 13, 2024 15:03
@adamdehaven adamdehaven disabled auto-merge March 13, 2024 15:18
@adamdehaven adamdehaven merged commit eecffb2 into main Mar 13, 2024
31 checks passed
@adamdehaven adamdehaven deleted the feat/update-swagger-ui branch March 13, 2024 15:18
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.

5 participants