richie icon indicating copy to clipboard operation
richie copied to clipboard

Update Search http API documentation

Open mbenadda opened this issue 7 years ago • 1 comments

Bug Report

Expected behavior/code API docs (Blueprints https://github.com/openfun/richie/blob/master/src/richie/apps/search/description.apib) should be up-to-date with the actual API.

Actual Behavior The docs are missing critical parts of the API, such as facets.

Steps to Reproduce N/A

Environment N/A

Possible Solution Update the API docs to match the current state of the API

Additional context/Screenshots N/A

mbenadda avatar Oct 05 '18 09:10 mbenadda

Maybe adding automated testing with Dredd in the CI would help keeping this spec up-to-date?

jmaupetit avatar Oct 05 '18 11:10 jmaupetit