Update Swagger UI (#6546) #6719

nadove-ucsc · 2024-11-20T04:16:10Z

Connected issues: #6546

Checklist

Author

PR is a draft
Target branch is develop
Name of PR branch matches issues/<GitHub handle of author>/<issue#>-<slug>
On ZenHub, PR is connected to all issues it (partially) resolves
PR description links to connected issues
PR title matches¹ that of a connected issue _{or comment in PR explains why they're different}
PR title references all connected issues
For each connected issue, there is at least one commit whose title references that issue

¹ when the issue title describes a problem, the corresponding PR
title is Fix: followed by the issue title

Author (partiality)

Added p tag to titles of partial commits
This PR is labeled partial _{or completely resolves all connected issues}
This PR partially resolves each of the connected issues _{or does not have the partial label}

Author (chains)

This PR is blocked by previous PR in the chain _{or is not chained to another PR}
The blocking PR is labeled base _{or this PR is not chained to another PR}
This PR is labeled chained _{or is not chained to another PR}

Author (reindex, API changes)

Added r tag to commit title _{or the changes introduced by this PR will not require reindexing of any deployment}
This PR is labeled reindex:dev _{or the changes introduced by it will not require reindexing of dev}
This PR is labeled reindex:anvildev _{or the changes introduced by it will not require reindexing of anvildev}
This PR is labeled reindex:anvilprod _{or the changes introduced by it will not require reindexing of anvilprod}
This PR is labeled reindex:prod _{or the changes introduced by it will not require reindexing of prod}
This PR is labeled reindex:partial and its description documents the specific reindexing procedure for dev, anvildev, anvilprod and prod _{or requires a full reindex or carries none of the labels reindex:dev, reindex:anvildev, reindex:anvilprod and reindex:prod}
This PR and its connected issues are labeled API _{or this PR does not modify a REST API}
Added a (A) tag to commit title for backwards (in)compatible changes _{or this PR does not modify a REST API}
Updated REST API version number in app.py _{or this PR does not modify a REST API}

Author (upgrading deployments)

Ran make docker_images.json and committed the resulting changes _{or this PR does not modify azul_docker_images, or any other variables referenced in the definition of that variable}
Documented upgrading of deployments in UPGRADING.rst _{or this PR does not require upgrading deployments}
Added u tag to commit title _{or this PR does not require upgrading deployments}
This PR is labeled upgrade _{or does not require upgrading deployments}
This PR is labeled deploy:shared _{or does not modify docker_images.json, and does not require deploying the shared component for any other reason}
This PR is labeled deploy:gitlab _{or does not require deploying the gitlab component}
This PR is labeled deploy:runner _{or does not require deploying the runner image}

Author (hotfixes)

Added F tag to main commit title _{or this PR does not include permanent fix for a temporary hotfix}
Reverted the temporary hotfixes for any connected issues _{or the none of the stable branches (anvilprod and prod) have temporary hotfixes for any of the issues connected to this PR}

Author (before every review)

Rebased PR branch on develop, squashed old fixups
Ran make requirements_update _{or this PR does not modify requirements*.txt, common.mk, Makefile and Dockerfile}
Added R tag to commit title _{or this PR does not modify requirements*.txt}
This PR is labeled reqs _{or does not modify requirements*.txt}
make integration_test passes in personal deployment _{or this PR does not modify functionality that could affect the IT outcome}

Peer reviewer (after approval)

PR is not a draft
Ticket is in Review requested column
PR is awaiting requested review from system administrator
PR is assigned to only the system administrator

System administrator (after approval)

Actually approved the PR
Labeled connected issues as demo or no demo
Commented on connected issues about demo expectations _{or all connected issues are labeled no demo}
Decided if PR can be labeled no sandbox
A comment to this PR details the completed security design review
PR title is appropriate as title of merge commit
N reviews label is accurate
Moved connected issues to Approved column
PR is assigned to only the operator

Operator (before pushing merge the commit)

System administrator

Background migrations for dev.gitlab are complete _{or this PR is not labeled deploy:gitlab}
Background migrations for anvildev.gitlab are complete _{or this PR is not labeled deploy:gitlab}
PR is assigned to only the operator

Operator (before pushing merge the commit)

Operator (chain shortening)

Changed the target branch of the blocked PR to develop _{or this PR is not labeled base}
Removed the chained label from the blocked PR _{or this PR is not labeled base}
Removed the blocking relationship from the blocked PR _{or this PR is not labeled base}
Removed the base label from this PR _{or this PR is not labeled base}

Operator (after pushing the merge commit)

Operator (reindex)

Operator

Propagated the deploy:shared, deploy:gitlab, deploy:runner, API, reindex:partial, reindex:anvilprod and reindex:prod labels to the next promotion PRs _{or this PR carries none of these labels}
Propagated any specific instructions related to the deploy:shared, deploy:gitlab, deploy:runner, API, reindex:partial, reindex:anvilprod and reindex:prod labels, from the description of this PR to that of the next promotion PRs _{or this PR carries none of these labels}
PR is assigned to no one

Shorthand for review comments

L line is too long
W line wrapping is wrong
Q bad quotes
F other formatting problem

codecov · 2024-11-20T04:54:59Z

Codecov Report

Attention: Patch coverage is 41.66667% with 7 lines in your changes missing coverage. Please review.

Project coverage is 85.56%. Comparing base (93637ff) to head (c1667e3).

Files with missing lines	Patch %	Lines
src/azul/chalice.py	45.45%	6 Missing ⚠️
test/integration_test.py	0.00%	1 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff             @@
##           develop    #6719      +/-   ##
===========================================
- Coverage    85.57%   85.56%   -0.01%     
===========================================
  Files          154      154              
  Lines        20915    20920       +5     
===========================================
+ Hits         17897    17901       +4     
- Misses        3018     3019       +1

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚨 Try these New Features:

Flaky Tests Detection - Detect and resolve failed and flaky tests
JS Bundle Analysis - Avoid shipping oversized bundles

coveralls · 2024-11-20T04:56:03Z

coverage: 85.586% (-0.001%) from 85.587%
when pulling c1667e3 on issues/nadove-ucsc/6546-update-swagger-ui
into 93637ff on develop.

to match the version of the other Swagger resource files

https://github.com/swagger-api/swagger-ui/tree/v5.18.2/dist

dsotirho-ucsc

Approved.

github-actions bot added the orange [process] Done by the Azul team label Nov 20, 2024

nadove-ucsc force-pushed the issues/nadove-ucsc/6546-update-swagger-ui branch from f18f65d to bf8ddd7 Compare November 20, 2024 04:34

nadove-ucsc requested a review from dsotirho-ucsc November 20, 2024 05:07

nadove-ucsc assigned dsotirho-ucsc and unassigned dsotirho-ucsc Nov 20, 2024

nadove-ucsc force-pushed the issues/nadove-ucsc/6546-update-swagger-ui branch 4 times, most recently from 8dd61c1 to d786f9f Compare November 21, 2024 04:43

nadove-ucsc added 3 commits November 21, 2024 14:56

Fix quotes

3ec1138

Use swagger_resource method

f8b9a52

Update OAuth2 redirect page to v4.15.2

f6acbe1

to match the version of the other Swagger resource files

nadove-ucsc force-pushed the issues/nadove-ucsc/6546-update-swagger-ui branch 2 times, most recently from bdf7b37 to b1946f8 Compare November 22, 2024 00:59

nadove-ucsc added 4 commits November 21, 2024 17:51

Move Swagger UI to /static/index.html

f18a88c

Extract inline JS in Swagger UI to initializer script

4703b9b

Document Swagger update procedure and add script (#6546)

65e9fd0

Update Swagger UI to v5.18.2 (#6546)

c1667e3

https://github.com/swagger-api/swagger-ui/tree/v5.18.2/dist

nadove-ucsc force-pushed the issues/nadove-ucsc/6546-update-swagger-ui branch from b1946f8 to c1667e3 Compare November 22, 2024 02:00

nadove-ucsc assigned dsotirho-ucsc Nov 22, 2024

dsotirho-ucsc approved these changes Nov 23, 2024

View reviewed changes

dsotirho-ucsc marked this pull request as ready for review November 23, 2024 00:13

dsotirho-ucsc requested a review from hannes-ucsc as a code owner November 23, 2024 00:13

dsotirho-ucsc assigned hannes-ucsc and unassigned dsotirho-ucsc Nov 23, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update Swagger UI (#6546) #6719

Update Swagger UI (#6546) #6719

nadove-ucsc commented Nov 20, 2024 •

edited by dsotirho-ucsc

Loading

codecov bot commented Nov 20, 2024 •

edited

Loading

coveralls commented Nov 20, 2024 •

edited

Loading

dsotirho-ucsc left a comment

Update Swagger UI (#6546) #6719

Are you sure you want to change the base?

Update Swagger UI (#6546) #6719

Conversation

nadove-ucsc commented Nov 20, 2024 • edited by dsotirho-ucsc Loading

Checklist

Author

Author (partiality)

Author (chains)

Author (reindex, API changes)

Author (upgrading deployments)

Author (hotfixes)

Author (before every review)

Peer reviewer (after approval)

System administrator (after approval)

Operator (before pushing merge the commit)

System administrator

Operator (before pushing merge the commit)

Operator (chain shortening)

Operator (after pushing the merge commit)

Operator (reindex)

Operator

Shorthand for review comments

codecov bot commented Nov 20, 2024 • edited Loading

Codecov Report

coveralls commented Nov 20, 2024 • edited Loading

dsotirho-ucsc left a comment

Choose a reason for hiding this comment

nadove-ucsc commented Nov 20, 2024 •

edited by dsotirho-ucsc

Loading

codecov bot commented Nov 20, 2024 •

edited

Loading

coveralls commented Nov 20, 2024 •

edited

Loading