Add writeOnly attribute for a load_only field if OpenAPI version >= 3

Author: lafrech

apispec/ext/marshmallow/swagger.py

@@ -135,7 +135,7 @@ def field2choices(field, **kwargs):
     return attributes
 
 
-def field2dump_only(field, **kwargs):
+def field2read_only(field, **kwargs):
     """Return the dictionary of swagger field attributes for a dump_only field.
 
     :param Field field: A marshmallow field.
@@ -147,6 +147,18 @@ def field2dump_only(field, **kwargs):
     return attributes
 
 
+def field2write_only(field, **kwargs):
+    """Return the dictionary of swagger field attributes for a load_only field.
+
+    :param Field field: A marshmallow field.
+    :rtype: dict
+    """
+    attributes = {}
+    if field.load_only and kwargs['openapi_major_version'] >= 3:
+        attributes['writeOnly'] = True
+    return attributes
+
+
 def field2nullable(field, **kwargs):
     """Return the dictionary of swagger field attributes for a nullable field.
 
@@ -322,7 +334,8 @@ def field2property(field, spec=None, use_refs=True, dump=True, name=None):
 
     for attr_func in (
         field2choices,
-        field2dump_only,
+        field2read_only,
+        field2write_only,
         field2nullable,
         field2range,
         field2length,

tests/test_swagger.py

@@ -387,20 +387,32 @@ class NotASchema(object):
         assert excinfo.value.args[0] == ("{0!r} doesn't have either `fields` "
                                          "or `_declared_fields`".format(NotASchema))
 
-    def test_dump_only_load_only_fields(self):
+    @pytest.mark.parametrize('openapi_version', ['2.0.0', '3.0.0'])
+    def test_dump_only_load_only_fields(self, openapi_version):
+        spec = APISpec(
+            title='Pets',
+            version='0.1',
+            plugins=['apispec.ext.marshmallow'],
+            openapi_version=openapi_version
+        )
+
         class UserSchema(Schema):
             _id = fields.Str(dump_only=True)
             name = fields.Str()
             password = fields.Str(load_only=True)
 
-        res = swagger.schema2jsonschema(UserSchema())
+        res = swagger.schema2jsonschema(UserSchema(), spec)
         props = res['properties']
         assert 'name' in props
         # dump_only field appears with readOnly attribute
         assert '_id' in props
         assert 'readOnly' in props['_id']
         # load_only field appears (writeOnly attribute does not exist)
         assert 'password' in props
+        if openapi_version == '2.0.0':
+            assert 'writeOnly' not in props['password']
+        else:
+            assert 'writeOnly' in props['password']
 
 
 class TestMarshmallowSchemaToParameters: