Magento REST API Schema (Swagger) is not compatible with Search Criteria

[careys7]

Preconditions

1. Magento 2 CE or EE (all versions)

Steps to reproduce

1. View Magento-generated Swagger Specification

Expected result

1. Search criteria described in working format

Actual result

1. HTTP 400 response from Magento when request sent in described format.

---

The Magento dev docs correctly describe REST API search criteria field groups and filters usage as needing an index per-field group / filter:

searchCriteria[filter_groups][<index>][filters][<index>][field=<field_name>]
searchCriteria[filter_groups][<index>][filters][<index>][value=<search_value>]
searchCriteria[filter_groups][<index>][filters][<index>][condition_type=<operator>]

When viewing the generated Swagger documentation, search criteria is described as follows (without a numerical index):

searchCriteria[filterGroups][][filters][][field]

Sending a request using searchCriteria in the format described by schema.json (without the numerical index) produces an HTTP 400 response. It also does not allow a user to define more than one filterGroup or filter, and breaks swagger-codegen clients.

The current searchCriteria implementation doesn't appear to be compatible with the Open API Specification in the current format.

[olysenko]

Hi @careysizer , thank you for your report. Internal ticket was created DDOC-11

[careys7]

Thanks @olysenko -

I've just updated the issue to be clear that the input described in the devdocs description is correct in terms of the input that Magento expects, and it is the Swagger schema produced by Magento/Webapi/Model/Rest/Swagger/Generator.php that is not.

[konstantinblaesi]

What's the current status? Is anyone working on fixing the search interface using swagger/swagger-codegen?

[springimport]

You can use my extension with fix for searchcriteria

"springimport/swagger-magento2-client": "dev-fix-searchcriteria-index"