include format with secret types (#1424)

* include format with secret types * fix: fix pr comments. Co-authored-by: Lasse Gravesen <lasse.gravesen@falcon.io>
pydantic · Apr 30, 2020 · 9238e3d · 9238e3d
1 parent 833d33d
commit 9238e3d
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 3 deletions.
diff --git a/changes/1424-atheuz.md b/changes/1424-atheuz.md
@@ -0,0 +1 @@
+include `'format': 'password'` in the schema for secret types
diff --git a/pydantic/types.py b/pydantic/types.py
@@ -540,7 +540,7 @@ def __modify_schema__(cls, field_schema: Dict[str, Any]) -> None:
 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', writeOnly=True, format='password')
 
     @classmethod
     def __get_validators__(cls) -> 'CallableGenerator':
@@ -576,7 +576,7 @@ def get_secret_value(self) -> str:
 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', writeOnly=True, format='password')
 
     @classmethod
     def __get_validators__(cls) -> 'CallableGenerator':

diff --git a/tests/test_schema.py b/tests/test_schema.py
@@ -580,7 +580,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'],
     }