include format with secret types

pydantic · Apr 23, 2020 · e9e9cd7 · e9e9cd7
1 parent f96c4dc
commit e9e9cd7
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 1 deletion.
diff --git a/changes/1424-atheuz.md b/changes/1424-atheuz.md
@@ -0,0 +1 @@
+include format with secret types #546
diff --git a/pydantic/types.py b/pydantic/types.py
@@ -531,6 +531,7 @@ class SecretStr:
     @classmethod
     def __modify_schema__(cls, field_schema: Dict[str, Any]) -> None:
         field_schema.update(type='string', writeOnly=True)
+        field_schema.update(type='string', format='password')
 
     @classmethod
     def __get_validators__(cls) -> 'CallableGenerator':
@@ -567,6 +568,7 @@ class SecretBytes:
     @classmethod
     def __modify_schema__(cls, field_schema: Dict[str, Any]) -> None:
         field_schema.update(type='string', writeOnly=True)
+        field_schema.update(type='string', format='password')
 
     @classmethod
     def __get_validators__(cls) -> 'CallableGenerator':

diff --git a/tests/test_schema.py b/tests/test_schema.py
@@ -579,7 +579,7 @@ class Model(BaseModel):
     base_schema = {
         'title': 'Model',
         'type': 'object',
-        'properties': {'a': {'title': 'A', 'type': inner_type, 'writeOnly': True}},
+        'properties': {'a': {'title': 'A', 'type': inner_type, 'writeOnly': True, 'format': 'password'}},
         'required': ['a'],
     }