Eve

-------------

Released on January 26, 2020.

- Fix: Mixing foreign and local object ids breaks querying (`1345`_)

.. _`1345`: https://github.com/pyeve/eve/issues/1345

-----------

Released on December 19, 2019.

New
~~~
- Python 3.8 added to CI matrix (`1326`_)
- Drop support for Python 3.4 (`1297`_)
- ``unique_within_resource`` validation rule. Enforces the uniqueness of an
attribute only at API resource level, contrasting with the ``unique`` rule
that enforces uniqueness at database collection level (`1291`_)
- Add doc8 to dev-requirements (`1343`_)

.. _`1343`: https://github.com/pyeve/eve/issues/1343
.. _`1326`: https://github.com/pyeve/eve/issues/1326
.. _`1297`: https://github.com/pyeve/eve/issues/1297
.. _`1291`: https://github.com/pyeve/eve/issues/1291

Fixed
~~~~~
- Pin to Cerberus < 2.0 (`1342`_)
- 500 error when PATCH or PUT are performed on Mongo 4.2 and ``_id`` is
included with payload (`1341`_)
- Minor style improvements and 2 test fixes (`1330`_)
- Werkzeug 0.15.4 crashes with Python 3.8 (`1325`_)
- Curl request in projection examples do not work (`1298`_)
- Update installation instructions (`1303`_)
- (*breaking*) Delete on empty resource returns 404, should return 204
(`1299`_)
- ``MONGO_REPLICA_SET`` ignored (`1302`_)
- Documentation typo (`1293`_, `1315`_, `1322`_, `1324`_, `1327`_)
- Flask 1.1.1 breaks ``test_logging_info`` test (`1296`_)
- Display the full release number on Eve frontpage.
- Update link to EveGenie repository. New maintainer: David Zisky.

.. _`1342`: https://github.com/pyeve/eve/issues/1342
.. _`1341`: https://github.com/pyeve/eve/issues/1341
.. _`1330`: https://github.com/pyeve/eve/pull/1330
.. _`1327`: https://github.com/pyeve/eve/pull/1327
.. _`1325`: https://github.com/pyeve/eve/pull/1325
.. _`1324`: https://github.com/pyeve/eve/pull/1324
.. _`1322`: https://github.com/pyeve/eve/pull/1322
.. _`1315`: https://github.com/pyeve/eve/pull/1315
.. _`1298`: https://github.com/pyeve/eve/issues/1298
.. _`1303`: https://github.com/pyeve/eve/pull/1303
.. _`1299`: https://github.com/pyeve/eve/issues/1299
.. _`1302`: https://github.com/pyeve/eve/issues/1302
.. _`1296`: https://github.com/pyeve/eve/issues/1296
.. _`1293`: https://github.com/pyeve/eve/issues/1293

-------------

Released on June 14, 2019.

Fixed
~~~~~


- Geo queries lack support for the ``$minDistance`` mongo operator (`1281`_)
- Lookup argument does not get passed to ``pre_<event>`` hook with certain
resource urls (`1283`_)
- PUT requests doesn't set default values for fields that have one defined
(`1280`_)
- PATCH crashes when normalizing default fields (`1275`_, `1274`_)
- The condition that avoids returning ``X-Total-Count`` when counting is
disabled also filters out the case where the resource is empty and count is
0 (`1279`_)
- First example of Eve use doesn't really work (`1277`_)

.. _`1283`: https://github.com/pyeve/eve/issues/1283
.. _`1281`: https://github.com/pyeve/eve/issues/1281
.. _`1280`: https://github.com/pyeve/eve/issues/1280
.. _`1277`: https://github.com/pyeve/eve/issues/1277
.. _`1275`: https://github.com/pyeve/eve/issues/1275
.. _`1274`: https://github.com/pyeve/eve/issues/1274
.. _`1279`: https://github.com/pyeve/eve/issues/1279

-------------

Released on May 22, 2019.

New
~~~~~
- ``NORMALIZE_ON_PATCH`` switches normalization on patch requests (`1234`_)

Fixed
~~~~~
- Document count broken with concurrent requests (`1271`_)
- Document count broken when embedded resources are requested (`1268`_)
- If ``ignore_fields`` contains a nested field, document is mutated (`1266`_)
- Crash with Werzeug >= 0.15.3 (`1267`_)
- Fix crash when trying to ignore a nested field that doesn't exist (`1263`_)

Improved
~~~~~~~~
- Remove unsupported ``transparent_schema_rules`` option from docs (`1264`_)
- Bump (and pin) Wekzeug to 0.15.4 (`1267`_)
- Quickstart: a better ``MONGO_AUTH_SOURCE`` explanation (`1168`_)

Breaking Changes
~~~~~~~~~~~~~~~~

No known breaking changes for the standard framework user. However, if you are
consuming the developer API:

- Be aware that ``io.base.DataLayer.find()`` signature has changed and an
optional ``perform_count`` argument has been added. The method return value
is now a tuple ``(cursor, count)``; ``cursor`` is the query result as
before while ``count`` is the document count, which is expected to have a
consistent value when ``perform_count = True``.

.. _`1271`: https://github.com/pyeve/eve/issues/1271
.. _`1268`: https://github.com/pyeve/eve/issues/1268
.. _`1168`: https://github.com/pyeve/eve/issues/1168
.. _`1266`: https://github.com/pyeve/eve/pull/1266
.. _`1234`: https://github.com/pyeve/eve/issues/1234
.. _`1267`: https://github.com/pyeve/eve/issues/1267
.. _`1263`: https://github.com/pyeve/eve/pull/1263
.. _`1264`: https://github.com/pyeve/eve/issues/1264

-----------

Released on April 11, 2019.

Breaking changes
~~~~~~~~~~~~~~~~
- Werkzeug v0.15.1+ is required. You want to upgrade, otherwise your Eve
environment is likely to break. For the full story, see `1245`_ and
`1251`_.

New
~~~
- HATEOAS support added to aggregation results (`1208`_)
- ``on_fetched_diffs`` event hooks (`1224`_)
- Support for Mongo 3.6+ ``$expr`` query operator.
- Support for Mongo 3.6+ ``$center`` query operator.

Fixed
~~~~~
- Insertion failure when replacing unknown field with dbref value (`1255`_,
`1257`_)
- ``max_results=1`` should be honored on aggregation endpoints (`1250`_)
- PATCH incorrectly normalizes default values in subdocuments (`1234`_)
- Unauthorized Exception not working with Werkzeug >= 15.0 (`1245`_, `1251`_)
- Embedded documents not being sorted correctly (`1217`_)
- Eve crashes on malformed sort parameters (`1248`_)
- Insertion failure when replacing a same document containing dbref (`1216`_)
- Datasource projection is not respected for POST requests (`1189`_)
- Soft delete removes ``auth_field`` from document (`1188`_)
- On Mongo 3.6+, we don't return 400 'immutable field' on PATCH and PUT
(`1243`_)
- Expecting JSON response for rate limit exceeded scenario (`1227`_)
- Multiple concurrent patches to the same record, from different processes,
should result in at least one patch failing with a 412 error (Precondition
Failed) (`1231`_)
- Embedding only does not follow ``data_relation.field`` (`1069`_)
- HATEOAS ``_links`` seems to get an extra ``&version=diffs`` (`1228`_)
- Do not alter ETag when performing an oplog_push (`1206`_)
- CORS response headers missing for media endpoint (`1197`_)
- Warning: Unexpected keys present on black: ``python_version`` (`1244`_)
- UserWarning: JSON setting is deprecated. Use RENDERERS instead (`1241`_).
- DeprecationWarning: decodestring is deprecated, use decodebytes (`1242`_)
- DeprecationWarning: count is deprecated. Use Collection.count_documents
instead (`1202`_)
- Documentation typos (`1218`_, `1240`_)

Improved
~~~~~~~~
- Eve package is now distributed as a Python wheel (`1260`_)
- Bump Werkzeug version to v0.15.1+ (`1245`_, `1251`_)
- Bump PyMongo version to v3.7+ (`1202`_)
- Python 3.7 added to the CI matrix (`1199`_)
- Option to omit the aggregation stage when its parameter is empty/unset
(`1209`_)
- HATEOAS: now the ``_links`` dictionary may have a ``related`` dictionary
inside, and each key-value pair yields the related links for a data relation
field (`1204`_)
- XML renderer now supports data field tag attributes such as ``href`` and
``title`` (`1204`_)
- Make the parsing of ``req.sort`` and ``req.where`` easily reusable by moving
their logic to dedicated methods (`1194`_)
- Add a "Python 3 is highly preferred" note on the homepage (`1198`_)
- Drop sphinx-contrib-embedly when building docs.

.. _`1260`: https://github.com/pyeve/eve/issues/1260
.. _`1208`: https://github.com/pyeve/eve/issues/1208
.. _`1257`: https://github.com/pyeve/eve/issues/1257
.. _`1255`: https://github.com/pyeve/eve/issues/1255
.. _`1250`: https://github.com/pyeve/eve/issues/1250
.. _`1234`: https://github.com/pyeve/eve/issues/1234
.. _`1251`: https://github.com/pyeve/eve/pull/1251
.. _`1245`: https://github.com/pyeve/eve/pull/1245
.. _`1217`: https://github.com/pyeve/eve/pull/1217
.. _`1248`: https://github.com/pyeve/eve/issues/1248
.. _`1234`: https://github.com/pyeve/eve/issues/1234
.. _`1216`: https://github.com/pyeve/eve/issues/1216
.. _`1244`: https://github.com/pyeve/eve/issues/1244
.. _`1189`: https://github.com/pyeve/eve/issues/1189
.. _`1188`: https://github.com/pyeve/eve/issues/1188
.. _`1198`: https://github.com/pyeve/eve/issues/1198
.. _`1199`: https://github.com/pyeve/eve/issues/1199
.. _`1243`: https://github.com/pyeve/eve/issues/1243
.. _`1241`: https://github.com/pyeve/eve/issues/1241
.. _`1242`: https://github.com/pyeve/eve/issues/1242
.. _`1202`: https://github.com/pyeve/eve/issues/1202
.. _`1240`: https://github.com/pyeve/eve/issues/1240
.. _`1227`: https://github.com/pyeve/eve/issues/1227
.. _`1231`: https://github.com/pyeve/eve/issues/1231
.. _`1069`: https://github.com/pyeve/eve/issues/1069
.. _`1224`: https://github.com/pyeve/eve/pull/1224
.. _`1228`: https://github.com/pyeve/eve/pull/1228
.. _`1218`: https://github.com/pyeve/eve/pull/1218
.. _`1209`: https://github.com/pyeve/eve/issues/1209
.. _`1206`: https://github.com/pyeve/eve/issues/1206
.. _`1204`: https://github.com/pyeve/eve/pull/1204
.. _`1194`: https://github.com/pyeve/eve/pull/1194
.. _`1197`: https://github.com/pyeve/eve/issues/1197

-------------

Released on October 4, 2018.

New
~~~
- Add support for Mongo ``$centerSphere`` query operator (`1181`_)
- ``NORMALIZE_DOTTED_FIELDS``. If ``True``, dotted fields are parsed and
processed as subdocument fields. If ``False``, dotted fields are left
unparsed and unprocessed and the payload is passed to the underlying
data-layer as-is. Please note that with the default Mongo layer, setting this
to ``False`` will result in an error. Defaults to ``True``. (`1173`_)
- ``normalize_dotted_fields``. Endpoint-level override
for ``NORMALIZE_DOTTED_FIELDS``. (`1173`_)

Fixed
~~~~~
- ``mongo_indexes``: "OperationFailure" when changing the keys of an existing
index (`1180`_)
- v0.8: "OperationFailure" performing MongoDB full text searches (`1176`_)
- "AttributeError" on Python 2.7 when obsolete ``JSON`` or ``XML`` settings
are used (`1175`_).
- "TypeError argument of type 'NoneType' is not iterable" error when using
document embedding in conjuction with soft deletes (`1120`_)
- ``allow_unknown`` validation rule fails with nested dict fields (`1163`_)
- Updating a field with a nullable data relation fails when value is null
(`1159`_)
- "cerberus.schema.SchemaError" when ``VALIDATE_FILTERS = True``. (`1154`_)
- Serializers fails when array of types is in schema. (`1112`_)
- Replace the broken ``make audit`` shortcut with ``make check``, add the
command to ``CONTRIBUTING.rst`` it was missing. (`1144`_)

Improved
~~~~~~~~
- Perform lint checks and fixes on staged files, as a pre-commit hook.
(`1157`_)
- On CI, perform linting checks first. If linting checks are successful,
execute the test suite on the whole matrix. (`1156`_)
- Reformat code to match Black code-style. (`1155`_)
- Use ``simplejson`` everywhere in the codebase. (`1148`_)
- Install a bot that flags and closes stale issues/pull requests. (`1145`_)
- Only set the package version in ``__init__.py``. (`1142`_)

Docs
~~~~
- Typos (`1183`_, `1184`_, `1185`_)
- Add ``MONGO_AUTH_SOURCE`` to Quickstart. (`1168`_)
- Fix Sphinx-embedly error when embedding speakerdeck.com slide deck (`1158`_)
- Fix broken link to the Postman app. (`1150`_)
- Update obsolete PyPI link in docs sidebar. (`1152`_)
- Only display the version number on the docs homepage. (`1151`_)
- Fix documentation builds on Read the Docs. (`1147`_)
- Add a ``ISSUE_TEMPLATE.md`` GitHub template file. (`1146`_)
- Improve changelog format to reduce noise and increase readability. (`1143`_)

.. _`1185`: https://github.com/pyeve/eve/pull/1185
.. _`1184`: https://github.com/pyeve/eve/pull/1184
.. _`1183`: https://github.com/pyeve/eve/pull/1183
.. _`1181`: https://github.com/pyeve/eve/issues/1181
.. _`1180`: https://github.com/pyeve/eve/issues/1180
.. _`1176`: https://github.com/pyeve/eve/issues/1176
.. _`1175`: https://github.com/pyeve/eve/issues/1175
.. _`1173`: https://github.com/pyeve/eve/issues/1173
.. _`1168`: https://github.com/pyeve/eve/issues/1168
.. _`1142`: https://github.com/pyeve/eve/issues/1142
.. _`1143`: https://github.com/pyeve/eve/issues/1143
.. _`1144`: https://github.com/pyeve/eve/issues/1144
.. _`1145`: https://github.com/pyeve/eve/issues/1145
.. _`1146`: https://github.com/pyeve/eve/issues/1146
.. _`1147`: https://github.com/pyeve/eve/issues/1147
.. _`1148`: https://github.com/pyeve/eve/issues/1148
.. _`1151`: https://github.com/pyeve/eve/issues/1151
.. _`1152`: https://github.com/pyeve/eve/issues/1152
.. _`1150`: https://github.com/pyeve/eve/issues/1150
.. _`1112`: https://github.com/pyeve/eve/issues/1112
.. _`1154`: https://github.com/pyeve/eve/issues/1154
.. _`1155`: https://github.com/pyeve/eve/issues/1155
.. _`1156`: https://github.com/pyeve/eve/issues/1156
.. _`1157`: https://github.com/pyeve/eve/issues/1157
.. _`1158`: https://github.com/pyeve/eve/issues/1158
.. _`1159`: https://github.com/pyeve/eve/issues/1159
.. _`1163`: https://github.com/pyeve/eve/issues/1163
.. _`1120`: https://github.com/pyeve/eve/issues/1120