Skip to content

Commit cef665c

Browse files
authored
Correct pydoc to show swagger_ui_options param type SwaggerUIOptions (#2001)
Previously documented as options.ConnexionOptions, which does not exist Co-authored-by: Christopher Lott <[email protected]>
1 parent 3450a60 commit cef665c

File tree

4 files changed

+7
-7
lines changed

4 files changed

+7
-7
lines changed

connexion/apps/abstract.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ def __init__(
7575
start.
7676
:param strict_validation: When True, extra form or query parameters not defined in the
7777
specification result in a validation error. Defaults to False.
78-
:param swagger_ui_options: Instance of :class:`options.ConnexionOptions` with
78+
:param swagger_ui_options: Instance of :class:`options.SwaggerUIOptions` with
7979
configuration options for the swagger ui.
8080
:param uri_parser_class: Class to use for uri parsing. See :mod:`uri_parsing`.
8181
:param validate_responses: Whether to validate responses against the specification. This has
@@ -162,7 +162,7 @@ def add_api(
162162
start.
163163
:param strict_validation: When True, extra form or query parameters not defined in the
164164
specification result in a validation error. Defaults to False.
165-
:param swagger_ui_options: A :class:`options.ConnexionOptions` instance with configuration
165+
:param swagger_ui_options: A :class:`options.SwaggerUIOptions` instance with configuration
166166
options for the swagger ui.
167167
:param uri_parser_class: Class to use for uri parsing. See :mod:`uri_parsing`.
168168
:param validate_responses: Whether to validate responses against the specification. This has

connexion/apps/asynchronous.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -168,7 +168,7 @@ def __init__(
168168
start.
169169
:param strict_validation: When True, extra form or query parameters not defined in the
170170
specification result in a validation error. Defaults to False.
171-
:param swagger_ui_options: Instance of :class:`options.ConnexionOptions` with
171+
:param swagger_ui_options: Instance of :class:`options.SwaggerUIOptions` with
172172
configuration options for the swagger ui.
173173
:param uri_parser_class: Class to use for uri parsing. See :mod:`uri_parsing`.
174174
:param validate_responses: Whether to validate responses against the specification. This has

connexion/apps/flask.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -205,7 +205,7 @@ def __init__(
205205
:param auth_all_paths: whether to authenticate not paths not defined in the specification.
206206
Defaults to False.
207207
:param jsonifier: Custom jsonifier to overwrite json encoding for json responses.
208-
:param swagger_ui_options: A :class:`options.ConnexionOptions` instance with configuration
208+
:param swagger_ui_options: A :class:`options.SwaggerUIOptions` instance with configuration
209209
options for the swagger ui.
210210
:param pythonic_params: When True, CamelCase parameters are converted to snake_case and an
211211
underscore is appended to any shadowed built-ins. Defaults to False.
@@ -216,7 +216,7 @@ def __init__(
216216
start.
217217
:param strict_validation: When True, extra form or query parameters not defined in the
218218
specification result in a validation error. Defaults to False.
219-
:param swagger_ui_options: Instance of :class:`options.ConnexionOptions` with
219+
:param swagger_ui_options: Instance of :class:`options.SwaggerUIOptions` with
220220
configuration options for the swagger ui.
221221
:param uri_parser_class: Class to use for uri parsing. See :mod:`uri_parsing`.
222222
:param validate_responses: Whether to validate responses against the specification. This has

connexion/middleware/main.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -235,7 +235,7 @@ def __init__(
235235
start.
236236
:param strict_validation: When True, extra form or query parameters not defined in the
237237
specification result in a validation error. Defaults to False.
238-
:param swagger_ui_options: Instance of :class:`options.ConnexionOptions` with
238+
:param swagger_ui_options: Instance of :class:`options.SwaggerUIOptions` with
239239
configuration options for the swagger ui.
240240
:param uri_parser_class: Class to use for uri parsing. See :mod:`uri_parsing`.
241241
:param validate_responses: Whether to validate responses against the specification. This has
@@ -391,7 +391,7 @@ def add_api(
391391
:param strict_validation: When True, extra form or query parameters not defined in the
392392
specification result in a validation error. Defaults to False.
393393
:param swagger_ui_options: A dict with configuration options for the swagger ui. See
394-
:class:`options.ConnexionOptions`.
394+
:class:`options.SwaggerUIOptions`.
395395
:param uri_parser_class: Class to use for uri parsing. See :mod:`uri_parsing`.
396396
:param validate_responses: Whether to validate responses against the specification. This has
397397
an impact on performance. Defaults to False.

0 commit comments

Comments
 (0)