Add support for password string format
#132
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
`password` is a valid OpenAPIv3 string format, that is used as a UI hint
for frontend clients to mask the input field.
It was already present in the `SchemaFormat` enum, but it was not
handled in `_unmarshal_string` that uses `STRING_FORMAT_CALLABLE_GETTER`
to decide how to unmarshal a string, which would result in an error like
this one:
```
Traceback (most recent call last):
[... snip ...]
File ".venv/lib/python3.7/site-packages/openapi_core/validation/request/validators.py", line 37, in validate
body, body_errors = self._get_body(request, operation)
File ".venv/lib/python3.7/site-packages/openapi_core/validation/request/validators.py", line 82, in _get_body
body = media_type.unmarshal(raw_body, self.custom_formatters)
File ".venv/lib/python3.7/site-packages/openapi_core/schema/media_types/models.py", line 45, in unmarshal
unmarshalled = self.schema.unmarshal(deserialized, custom_formatters=custom_formatters)
File ".venv/lib/python3.7/site-packages/openapi_core/schema/schemas/models.py", line 189, in unmarshal
casted = self.cast(value, custom_formatters=custom_formatters, strict=strict)
File ".venv/lib/python3.7/site-packages/openapi_core/schema/schemas/models.py", line 179, in cast
return cast_callable(value)
File ".venv/lib/python3.7/site-packages/openapi_core/schema/schemas/models.py", line 295, in _unmarshal_object
value, custom_formatters=custom_formatters)
File ".venv/lib/python3.7/site-packages/openapi_core/schema/schemas/models.py", line 335, in _unmarshal_properties
prop_value, custom_formatters=custom_formatters)
File ".venv/lib/python3.7/site-packages/openapi_core/schema/schemas/models.py", line 189, in unmarshal
casted = self.cast(value, custom_formatters=custom_formatters, strict=strict)
File ".venv/lib/python3.7/site-packages/openapi_core/schema/schemas/models.py", line 179, in cast
return cast_callable(value)
File ".venv/lib/python3.7/site-packages/openapi_core/schema/schemas/models.py", line 295, in _unmarshal_object
value, custom_formatters=custom_formatters)
File ".venv/lib/python3.7/site-packages/openapi_core/schema/schemas/models.py", line 335, in _unmarshal_properties
prop_value, custom_formatters=custom_formatters)
File ".venv/lib/python3.7/site-packages/openapi_core/schema/schemas/models.py", line 189, in unmarshal
casted = self.cast(value, custom_formatters=custom_formatters, strict=strict)
File ".venv/lib/python3.7/site-packages/openapi_core/schema/schemas/models.py", line 179, in cast
return cast_callable(value)
File ".venv/lib/python3.7/site-packages/openapi_core/schema/schemas/models.py", line 215, in _unmarshal_string
formatstring = self.STRING_FORMAT_CALLABLE_GETTER[schema_format]
KeyError: <SchemaFormat.PASSWORD: 'password'>
```
password string format
Codecov Report
@@ Coverage Diff @@
## master #132 +/- ##
=======================================
Coverage 96.33% 96.33%
=======================================
Files 54 54
Lines 1474 1474
=======================================
Hits 1420 1420
Misses 54 54
Continue to review full report at Codecov.
|
1 similar comment
Codecov Report
@@ Coverage Diff @@
## master #132 +/- ##
=======================================
Coverage 96.33% 96.33%
=======================================
Files 54 54
Lines 1474 1474
=======================================
Hits 1420 1420
Misses 54 54
Continue to review full report at Codecov.
|
zupo
added a commit
to teamniteo/pyramid-realworld-example-app
that referenced
this pull request
Apr 26, 2019
Several things needed to happen in order for this to work: * Add Passlib, Argon2 and pyramid_jwt to dependencies and configure them. * Add `jwt.secret` .ini setting. * Comment out `format: password` in `openapi.yaml` due to a bug in `openapi-core`: python-openapi/openapi-core#132 * Finally, some cleanup: * `pyramid.reload_templates` is not needed because we don't use templates * `pyramid.default_locale_name` is not needed because we don't support localizations * `pyramid_debugtoolbar` is not needed because we always render JSON. * Uncaught errors are logged instead of included in API response in order not to leak sensitive system information.
zupo
pushed a commit
to teamniteo/pyramid-realworld-example-app
that referenced
this pull request
Apr 27, 2019
Several things needed to happen in order for this to work: * Add Passlib, Argon2 and pyramid_jwt to dependencies and configure them. * Add `jwt.secret` .ini setting. * Comment out `format: password` in `openapi.yaml` due to a bug in `openapi-core`: python-openapi/openapi-core#132 * Finally, some cleanup: * `pyramid.reload_templates` is not needed because we don't use templates * `pyramid.default_locale_name` is not needed because we don't support localizations * `pyramid_debugtoolbar` is not needed because we always render JSON. * Uncaught errors are logged instead of included in API response in order not to leak sensitive system information.
bjmc
pushed a commit
to bjmc/openapi-core
that referenced
this pull request
Jun 12, 2019
Add support for `password` string format
pcrespov
pushed a commit
to pcrespov/osparc-simcore
that referenced
this pull request
Jun 25, 2019
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
passwordis a valid OpenAPIv3 string format, that is used as a UI hintfor frontend clients to mask the input field.
It was already present in the
SchemaFormatenum, but it was nothandled in
_unmarshal_stringthat usesSTRING_FORMAT_CALLABLE_GETTERto decide how to unmarshal a string, which would result in an error like
this one: