Update docs; bump version; update changelog

marshmallow-code · Sep 27, 2015 · d7dd91f · d7dd91f
1 parent f95edad
commit d7dd91f
Show file tree

Hide file tree

Showing 7 changed files with 17 additions and 8 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -1,10 +1,11 @@
 Changelog
 ---------
 
-0.2.0 (unreleased)
+0.2.0 (2015-09-27)
 ++++++++++++++++++
 
 * Add ``schema2parameters``, ``fields2parameters``, and ``field2parameters``.
+* Removed ``Fixed`` from ``swagger.FIELD_MAPPING`` for compatibility with marshmallow>=2.0.0.
 
 0.1.0 (2015-09-13)
 ++++++++++++++++++

diff --git a/README.rst b/README.rst
@@ -13,8 +13,7 @@ A collection of utilities for designing and documenting RESTful APIs built with
 Features
 --------
 
-- Convert ``marshmallow.Schemas`` and ``webarg.Args`` into `Swagger 2.0 <http://swagger.io>`_ API definitions
-- Pagination (in progress)
+- Convert marshmallow ``Schemas`` and ``fields`` into `Swagger 2.0 <http://swagger.io>`_ API definitions
 - Automatic API documentation (in progress)
 
 

diff --git a/dev-requirements.txt b/dev-requirements.txt
@@ -4,7 +4,7 @@ invoke
 flake8==2.4.1
 
 # soft dependencies
-webargs>=0.16.0
+webargs>=0.15.0
 Flask
 
 # testing

diff --git a/docs/modules/swagger.rst b/docs/modules/swagger.rst
@@ -1,5 +1,5 @@
-`smore.swagger`: Generate Swagger definitions from marshmallow `Schemas` and webargs `Args`
-===========================================================================================
+`smore.swagger`: Generate Swagger definitions from marshmallow `Schemas` and `fields`
+=====================================================================================
 
 .. automodule:: smore.swagger
     :inherited-members:
diff --git a/setup.py b/setup.py
@@ -25,7 +25,7 @@ def find_version(fname):
         raise RuntimeError('Cannot find version information')
     return version
 
-__version__ = find_version("smore/__init__.py")
+__version__ = find_version('smore/__init__.py')
 
 
 def read(fname):

diff --git a/smore/__init__.py b/smore/__init__.py
@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
 
-__version__ = '0.1.0'
+__version__ = '0.2.0'
 __author__ = 'Steven Loria'
 __license__ = "MIT"
diff --git a/smore/swagger/__init__.py b/smore/swagger/__init__.py
@@ -129,6 +129,11 @@ def fields2parameters(fields, schema_cls=None, spec=None, use_refs=True, default
 
 
 def field2parameter(field, name='body', spec=None, use_refs=True, default_in='body'):
+    """Return Swagger parameter as a `dict`, given a marshmallow
+    :class:`Field <marshmallow.Field>`.
+
+    https://github.com/wordnik/swagger-spec/blob/master/versions/2.0.md#parameterObject
+    """
     location = field.metadata.pop('location', None)
     prop = field2property(field, spec=spec, use_refs=use_refs)
     return property2parameter(
@@ -138,6 +143,10 @@ def field2parameter(field, name='body', spec=None, use_refs=True, default_in='bo
 
 
 def arg2parameter(arg, name='body', default_in='body'):
+    """Return Swagger parameter as a `dict`, given a webargs `Arg <webargs.Arg>`.
+
+    https://github.com/wordnik/swagger-spec/blob/master/versions/2.0.md#parameterObject
+    """
     prop = arg2property(arg)
     return property2parameter(
         prop, name=arg.metadata.get('name', name), required=arg.required, multiple=arg.multiple,