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

Backport of Update packages and OpenApi styling into release/1.14.x #23824

Conversation

hc-github-team-secure-vault-core
Copy link
Contributor

Backport

This PR is auto-generated from #23700 to be assessed for backporting due to the inclusion of the label backport/1.14.x.

🚨

Warning automatic cherry-pick of commits failed. If the first commit failed,
you will see a blank no-op commit below. If at least one commit succeeded, you
will see the cherry-picked commits up to, not including, the commit where
the merge conflict occurred.

The person who merged in the original PR is:
@Monkeychip
This person should manually cherry-pick the original PR into a new backport PR,
and close this one when the manual backport PR is merged in.

merge conflict error: POST https://api.github.com/repos/hashicorp/vault/merges: 409 Merge conflict []

The below text is copied from the body of the original PR.


This PR updates packages that needed addressing after running yarn npm audit.

For the package swagger-ui-dist, the update broke the CSS. It did this by wrapping elements in buttons, changing the elements nesting structure, and replacing spans with divs. After some consideration, I decided on doing the following:

Edit: It also broke the filtering functionality because of a React update behind the scenes. I decided it was cleaner, easier, less bug prone to use Swagger's filtering input. See the updated screenshot for how this looks. This also means queryParam for URL sharing is no long available.

  1. Remove the old swagger-ui css styling.
  2. Create a new SCSS file and put into the uitls/ folder. This file now has access to any variables we may want. The only CSS I kept was hiding a header and removing a container padding for alignment reasons.
  3. All the old styling is removed aside for what is mentioned in 2. What is left is the default swagger styling. The swagger package needed to be updated and there are too many design considerations for trying to match the old styling to this new layout. This is especially true as we move towards HDS. Considerations include trying to match colors, title sizes and card layouts. A design ticket will address how to restyle this view for a later PR.

Old OpenAPI view
Screenshot 2023-10-17 at 12-39-46 Vault

After update
Screenshot 2023-10-19 at 16-11-57 Vault


Overview of commits

@hc-github-team-secure-vault-core hc-github-team-secure-vault-core force-pushed the backport/ui/VAULT-21121/outdated-packages/officially-intimate-finch branch from e6746f9 to e83f62d Compare October 25, 2023 17:06
@hashicorp-cla
Copy link

CLA assistant check

Thank you for your submission! We require that all contributors sign our Contributor License Agreement ("CLA") before we can accept the contribution. Read and sign the agreement

Learn more about why HashiCorp requires a CLA and what the CLA includes


temp seems not to be a GitHub user.
You need a GitHub account to be able to sign the CLA. If you already have a GitHub account, please add the email address used for this commit to your account.

Have you signed the CLA already but the status is still pending? Recheck it.

@github-actions github-actions bot added the hashicorp-contributed-pr If the PR is HashiCorp (i.e. not-community) contributed label Oct 25, 2023
@github-actions
Copy link

CI Results:
All Go tests succeeded! ✅

@Monkeychip Monkeychip closed this Nov 30, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
hashicorp-contributed-pr If the PR is HashiCorp (i.e. not-community) contributed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants