search

cpsgroup / sarapis

A RESTful, proxied, read-only Solr interface
http://sarapis.herokuapp.com
MIT License
1 stars 2 forks source link

Request Parameter Examples #12

Open MartinLichtblau opened 9 years ago

MartinLichtblau commented 9 years ago

I was trying out some of the admin request parameters and realized, that without knowing the proper syntax of the commands I will get lots of "error": "Bad Request" (e.g. for the GET Admin ). So perhaps it would be helpful to show and example command for every request, just hardcoded below the "Implementation Notes". @vyo What's you opinion about that?

vyo commented 9 years ago

The admin routes are not implemented as of yet, so naturally they will fail. I will probably remove the 'api' tag on them, so they don't show up on our swagger api for the time being. Might also add some sort of 'not implemented yet' sort of response to them. Or should we simply not register them for the time being?

edit: Basically this is strongy related to #3 and #5. But we should discuss the syntax for regular, i.e. solr requests. Should we allow solr-syntax, too, or even switch to it completely?

MartinLichtblau commented 9 years ago

Concerning the solr-syntax (Query Parser) I started a seprate issue #13.

vyo commented 9 years ago

Great! I will adjust the swagger configuration to exempt the stubbed admin endpoints.