feat(event_handler): add support for persisting authorization session in OpenAPI

[nlykkei]

Issue number: #4314

Summary

Add support for persisting authorization data (e.g. OAuth 2.0 access token), so it's not lost on browser close/refresh. It will be stored in the browser's local storage:

https://swagger.io/docs/open-source-tools/swagger-ui/usage/configuration/#:~:text=persistAuthorization

Changes

Add parameter to enable_swagger called persist_authorization that's provided to generate_swagger_html for Swagger UI HTML generation.

User experience

The user may persist tokens, so it's not necessary to re-authenicate after browser refresh.

Checklist

If your change doesn't seem to apply, please leave them unchecked.

• Meet tenets criteria
• I have performed a self-review of this change
• Changes have been tested
• Changes are documented
• PR title follows conventional commit semantics

Is this a breaking change?

No

RFC issue number:

Checklist:

• Migration process documented
• Implement warnings (if it can live side by side)

Acknowledgment

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.

[leandrodamascena]

Hello @nlykkei! Another great PR helping us improve the OpenAPI/SwaggerUI experience for customers.

Do you mind opening an issue as a Feature Request and explaining in 2 or 3 lines the use case? We always need to link a PR to an issue to keep track of what we are creating.

Thanks

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.31%. Comparing base (e14e768) to head (6cca561).
Report is 427 commits behind head on develop.

Additional details and impacted files

@@             Coverage Diff             @@
##           develop    #4312      +/-   ##
===========================================
- Coverage    96.38%   96.31%   -0.07%     
===========================================
  Files          214      217       +3     
  Lines        10030    10438     +408     
  Branches      1846     1930      +84     
===========================================
+ Hits          9667    10053     +386     
- Misses         259      270      +11     
- Partials       104      115      +11     

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

[nlykkei]

Hello @nlykkei! Another great PR helping us improve the OpenAPI/SwaggerUI experience for customers.

Do you mind opening an issue as a Feature Request and explaining in 2 or 3 lines the use case? We always need to link a PR to an issue to keep track of what we are creating.

Thanks

Thank you @leandrodamascena, and likewise! 🙂

I've linked the PR to an issue

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
10.1% Duplication on New Code

See analysis details on SonarCloud

[leandrodamascena]

APPROVED!