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

OpenAPI UI Hook to Event Subscriber #16552

Merged
merged 7 commits into from
Jan 2, 2024
Merged

Conversation

alexfinnarn
Copy link
Contributor

Description

Closes #16456 by moving a library attachment via a hook to an event subscriber.

Testing done

Manually tested that "/admin/config/services/openapi" only has one JSON schema listed to explore and Swagger UI still works.

Screenshots

Screenshot 2023-12-22 at 11 50 47 AM

QA steps

  1. Log into to the CMS as a user who can get to "/admin/config/services/openapi".
  2. Make sure only "VA.gov JSON:API" is listed under the Module column. JS hides two other options after the page loads that you'll probably see flicker while being removed.
  3. Click "Explore with Swagger UI" and see that it still loads.

Definition of Done

  • Documentation has been updated, if applicable.
  • Tests have been added if necessary.
  • Automated tests have passed.
  • Code Quality Tests have passed.
  • Acceptance Criteria in related issue are met.
  • Manual Code Review Approved.
  • If there are field changes, front end output has been thoroughly checked.

Select Team for PR review

  • CMS Team
  • Public websites
  • Facilities
  • User support
  • Accelerated Publishing

Copy link

GitHub Workflows (.github/workflows/*.yml)

Have you...

  • pinned all affected GitHub Actions at a specific commit by SHA?
  • reviewed the source code of the action at the commit you are pinning?
  • confirmed that no GitHub security measures are being bypassed?
  • checked for any injection of user content into protected contexts?
  • reviewed Security hardening for GitHub Actions?
  • reviewed GitHub Workflows?

@va-cms-bot va-cms-bot temporarily deployed to Tugboat December 22, 2023 16:56 Destroyed
@github-actions github-actions bot added Accelerated Publishing CMS Team CMS Product team that manages both editor exp and devops labels Dec 22, 2023
Copy link
Contributor

@tjheffner tjheffner left a comment

Choose a reason for hiding this comment

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

I had to clear caches for the swagger page to load correctly (complained about a missing schema prior), but otherwise this works well. Nice work on the event subscriber!

@JunTaoLuo JunTaoLuo added the refresh-tugboat-cache Used by GHA Tugboat automation label Dec 23, 2023
@github-actions github-actions bot removed the refresh-tugboat-cache Used by GHA Tugboat automation label Dec 23, 2023
@JunTaoLuo JunTaoLuo added the refresh-tugboat-cache Used by GHA Tugboat automation label Dec 23, 2023
@github-actions github-actions bot removed the refresh-tugboat-cache Used by GHA Tugboat automation label Dec 23, 2023
@JunTaoLuo JunTaoLuo added the refresh-tugboat-cache Used by GHA Tugboat automation label Dec 23, 2023
@github-actions github-actions bot removed the refresh-tugboat-cache Used by GHA Tugboat automation label Dec 23, 2023
@JunTaoLuo JunTaoLuo added the refresh-tugboat-cache Used by GHA Tugboat automation label Dec 23, 2023
@github-actions github-actions bot removed the refresh-tugboat-cache Used by GHA Tugboat automation label Dec 23, 2023
@JunTaoLuo JunTaoLuo added the refresh-tugboat-cache Used by GHA Tugboat automation label Dec 24, 2023
@github-actions github-actions bot removed the refresh-tugboat-cache Used by GHA Tugboat automation label Dec 24, 2023
@JunTaoLuo JunTaoLuo added the refresh-tugboat-cache Used by GHA Tugboat automation label Dec 24, 2023
@github-actions github-actions bot removed the refresh-tugboat-cache Used by GHA Tugboat automation label Dec 24, 2023
@JunTaoLuo JunTaoLuo added the refresh-tugboat-cache Used by GHA Tugboat automation label Dec 24, 2023
@github-actions github-actions bot removed the refresh-tugboat-cache Used by GHA Tugboat automation label Dec 24, 2023
@JunTaoLuo JunTaoLuo added the refresh-tugboat-cache Used by GHA Tugboat automation label Dec 24, 2023
@github-actions github-actions bot removed the refresh-tugboat-cache Used by GHA Tugboat automation label Dec 24, 2023
@JunTaoLuo JunTaoLuo added the refresh-tugboat-cache Used by GHA Tugboat automation label Dec 31, 2023
@github-actions github-actions bot removed the refresh-tugboat-cache Used by GHA Tugboat automation label Dec 31, 2023
@JunTaoLuo JunTaoLuo added the refresh-tugboat-cache Used by GHA Tugboat automation label Dec 31, 2023
@github-actions github-actions bot removed the refresh-tugboat-cache Used by GHA Tugboat automation label Dec 31, 2023
@JunTaoLuo JunTaoLuo added the refresh-tugboat-cache Used by GHA Tugboat automation label Dec 31, 2023
@github-actions github-actions bot removed the refresh-tugboat-cache Used by GHA Tugboat automation label Dec 31, 2023
@JunTaoLuo JunTaoLuo added the refresh-tugboat-cache Used by GHA Tugboat automation label Dec 31, 2023
@github-actions github-actions bot removed the refresh-tugboat-cache Used by GHA Tugboat automation label Dec 31, 2023
@JunTaoLuo JunTaoLuo added the refresh-tugboat-cache Used by GHA Tugboat automation label Jan 1, 2024
@github-actions github-actions bot removed the refresh-tugboat-cache Used by GHA Tugboat automation label Jan 1, 2024
@JunTaoLuo JunTaoLuo added the refresh-tugboat-cache Used by GHA Tugboat automation label Jan 1, 2024
@github-actions github-actions bot removed the refresh-tugboat-cache Used by GHA Tugboat automation label Jan 1, 2024
@JunTaoLuo JunTaoLuo added the refresh-tugboat-cache Used by GHA Tugboat automation label Jan 1, 2024
@github-actions github-actions bot removed the refresh-tugboat-cache Used by GHA Tugboat automation label Jan 1, 2024
@JunTaoLuo JunTaoLuo added the refresh-tugboat-cache Used by GHA Tugboat automation label Jan 1, 2024
@github-actions github-actions bot removed the refresh-tugboat-cache Used by GHA Tugboat automation label Jan 1, 2024
@JunTaoLuo JunTaoLuo added the refresh-tugboat-cache Used by GHA Tugboat automation label Jan 2, 2024
@github-actions github-actions bot removed the refresh-tugboat-cache Used by GHA Tugboat automation label Jan 2, 2024
@JunTaoLuo JunTaoLuo added the refresh-tugboat-cache Used by GHA Tugboat automation label Jan 2, 2024
@github-actions github-actions bot removed the refresh-tugboat-cache Used by GHA Tugboat automation label Jan 2, 2024
@JunTaoLuo JunTaoLuo added the refresh-tugboat-cache Used by GHA Tugboat automation label Jan 2, 2024
@github-actions github-actions bot removed the refresh-tugboat-cache Used by GHA Tugboat automation label Jan 2, 2024
@JunTaoLuo JunTaoLuo added the refresh-tugboat-cache Used by GHA Tugboat automation label Jan 2, 2024
@github-actions github-actions bot removed the refresh-tugboat-cache Used by GHA Tugboat automation label Jan 2, 2024
@va-cms-bot va-cms-bot temporarily deployed to Tugboat January 2, 2024 23:12 Destroyed
@tjheffner tjheffner enabled auto-merge (squash) January 2, 2024 23:30
@tjheffner tjheffner disabled auto-merge January 2, 2024 23:44
@tjheffner tjheffner merged commit 73a8a63 into main Jan 2, 2024
19 checks passed
@tjheffner tjheffner deleted the VACMS-16456-hook-to-event-b branch January 2, 2024 23:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Accelerated Publishing CMS Team CMS Product team that manages both editor exp and devops
Projects
None yet
Development

Successfully merging this pull request may close these issues.

OpenAPI UI Event Subscriber
4 participants