Parse Server REST API Aggregate Documentation (match vs $match, pipeline)

[threepwood]

Dear Community,

We have upgraded a legacy project Parse Server from version 2.8 to version 7.3. As we use Parse Server’s REST API, one of the changes we had to implement was to change our aggregate requests.

In this context, we noticed that the documentation does not reflect the latest version’s behaviour.

Could you please advise on the following:

1. Parameters such as match or group are now rejected. These do still work if passed on as $match and $group. However, this is not reflected in the documentation.
2. Parameter pipeline is new since version 3. However, this also is not reflected in the documentation.
3. We are currently using both approaches (parameters $match/$group and pipeline) in different use cases. Are there any plans to deprecate either?

Thank you for clarifying!

[Manuel]

@threepwood

Parameters such as match or group are now rejected. These do still work if passed on as $match and $group. However, this is not reflected in the documentation.

When you upgrade between major versions, I would recommend to jump only by 1 major version at a time. The changelog of each major release describes these breaking changes.

For the aggregation pipeline operators, this change has been described in the changelog of release 6.0.0:

The MongoDB aggregation pipeline requires native MongoDB syntax instead of the custom Parse Server syntax; for example pipeline stage names require a leading dollar sign like $match and the MongoDB document ID is referenced using _id instead of objectId (#8362)

But it’s possible we didn’t update (all parts of) the documentation. If you find outdated docs that need to be updated, please open an issue in the docs repository.