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

feature(document-builder): improved types of security scheme methods #2068

Open
wants to merge 8 commits into
base: master
Choose a base branch
from

Conversation

xTCry
Copy link

@xTCry xTCry commented Sep 1, 2022

PR Checklist

Please check if your PR fulfills the following requirements:

PR Type

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • CI related changes
  • Other... Please describe:

What is the current behavior?

This is a typing improvement, based on the official Swagger documentation. It is also simplified to access some methods without specifying unnecessary parameters.
For example, why write .addApiKey({ type: 'apiKey'}, 'key1'), if the name of the method speaks for itself that it accepts only the type apiKey.
Also, HttpSchemaObject accepts bearerFormat, OpenIdConnectSchemeObject can use openIdConnectUrl. But they are not used in other ways

Updated the order of arguments in methods. (Added deprecation for old)
#1915 (comment)

Issue Number: N/A

What is the new behavior?

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

@xTCry
Copy link
Author

xTCry commented Oct 7, 2022

@micalevisk, can you please review this PR

@xTCry
Copy link
Author

xTCry commented Nov 24, 2022

@kamilmysliwiec, @micalevisk, can you accept this PR?

lib/document-builder.ts Outdated Show resolved Hide resolved
@xTCry
Copy link
Author

xTCry commented Mar 17, 2023

@kamilmysliwiec Can this improvement see the light in the next release?

@rtkid-nt
Copy link

rtkid-nt commented Apr 1, 2023

Good PR

@xTCry
Copy link
Author

xTCry commented Feb 27, 2024

@micalevisk, types updated

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.

3 participants