Skip to content

Correct pydoc to show swagger_ui_options param type SwaggerUIOptions #2001

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.

Sign up for GitHub

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

Merged
RobbeSneyders merged 1 commit into from
Nov 22, 2024
Merged

Correct pydoc to show swagger_ui_options param type SwaggerUIOptions #2001

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions connexion/apps/abstract.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ def __init__(
start.
:param strict_validation: When True, extra form or query parameters not defined in the
specification result in a validation error. Defaults to False.
:param swagger_ui_options: Instance of :class:`options.ConnexionOptions` with
:param swagger_ui_options: Instance of :class:`options.SwaggerUIOptions` with
configuration options for the swagger ui.
:param uri_parser_class: Class to use for uri parsing. See :mod:`uri_parsing`.
:param validate_responses: Whether to validate responses against the specification. This has
Expand Down Expand Up @@ -162,7 +162,7 @@ def add_api(
start.
:param strict_validation: When True, extra form or query parameters not defined in the
specification result in a validation error. Defaults to False.
:param swagger_ui_options: A :class:`options.ConnexionOptions` instance with configuration
:param swagger_ui_options: A :class:`options.SwaggerUIOptions` instance with configuration
options for the swagger ui.
:param uri_parser_class: Class to use for uri parsing. See :mod:`uri_parsing`.
:param validate_responses: Whether to validate responses against the specification. This has
Expand Down
2 changes: 1 addition & 1 deletion connexion/apps/asynchronous.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,7 @@ def __init__(
start.
:param strict_validation: When True, extra form or query parameters not defined in the
specification result in a validation error. Defaults to False.
:param swagger_ui_options: Instance of :class:`options.ConnexionOptions` with
:param swagger_ui_options: Instance of :class:`options.SwaggerUIOptions` with
configuration options for the swagger ui.
:param uri_parser_class: Class to use for uri parsing. See :mod:`uri_parsing`.
:param validate_responses: Whether to validate responses against the specification. This has
Expand Down
4 changes: 2 additions & 2 deletions connexion/apps/flask.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -205,7 +205,7 @@ def __init__(
:param auth_all_paths: whether to authenticate not paths not defined in the specification.
Defaults to False.
:param jsonifier: Custom jsonifier to overwrite json encoding for json responses.
:param swagger_ui_options: A :class:`options.ConnexionOptions` instance with configuration
:param swagger_ui_options: A :class:`options.SwaggerUIOptions` instance with configuration
options for the swagger ui.
:param pythonic_params: When True, CamelCase parameters are converted to snake_case and an
underscore is appended to any shadowed built-ins. Defaults to False.
Expand All @@ -216,7 +216,7 @@ def __init__(
start.
:param strict_validation: When True, extra form or query parameters not defined in the
specification result in a validation error. Defaults to False.
:param swagger_ui_options: Instance of :class:`options.ConnexionOptions` with
:param swagger_ui_options: Instance of :class:`options.SwaggerUIOptions` with
configuration options for the swagger ui.
:param uri_parser_class: Class to use for uri parsing. See :mod:`uri_parsing`.
:param validate_responses: Whether to validate responses against the specification. This has
Expand Down
4 changes: 2 additions & 2 deletions connexion/middleware/main.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -235,7 +235,7 @@ def __init__(
start.
:param strict_validation: When True, extra form or query parameters not defined in the
specification result in a validation error. Defaults to False.
:param swagger_ui_options: Instance of :class:`options.ConnexionOptions` with
:param swagger_ui_options: Instance of :class:`options.SwaggerUIOptions` with
configuration options for the swagger ui.
:param uri_parser_class: Class to use for uri parsing. See :mod:`uri_parsing`.
:param validate_responses: Whether to validate responses against the specification. This has
Expand Down Expand Up @@ -391,7 +391,7 @@ def add_api(
:param strict_validation: When True, extra form or query parameters not defined in the
specification result in a validation error. Defaults to False.
:param swagger_ui_options: A dict with configuration options for the swagger ui. See
:class:`options.ConnexionOptions`.
:class:`options.SwaggerUIOptions`.
:param uri_parser_class: Class to use for uri parsing. See :mod:`uri_parsing`.
:param validate_responses: Whether to validate responses against the specification. This has
an impact on performance. Defaults to False.
Expand Down