wger icon indicating copy to clipboard operation
wger copied to clipboard

Document REST API endpoints for search

Open rolandgeider opened this issue 9 years ago • 2 comments
trafficstars

There is currently no documentation for searching exercises and ingredients, since they are only used internally for the autocompleter but are something API users can also find useful. TODO:

  • Document the endpoints
  • Add simple filter options (e.g. the language is auto-selected, it should be possible to override this)
  • Make the response returned by both the exercise and ingredient endpoints use the same structure

rolandgeider avatar Sep 19 '16 20:09 rolandgeider

Hello @rolandgeider ! I've started using the 'wger' app myself. I came across the https://wger.de/api/v2/ page that does show how to access 'exercises' and 'ingredients'. What is this issue asking about in particular?

Let me know if the intended documentation should exist at a different location

Thanks

fossterer avatar Jun 28 '17 02:06 fossterer

@fossterer

I believe he is talking about the https://wger.de/api/v2/exercise/search API. Speaking of which I don't believe it has any way of sorting (tried https://wger.de/api/v2/exercise/search?ordering=value).

@rolandgeider To get a return JSON for the search API for exercises try https://wger.de/api/v2/exercise/search/?term=<Search Term>

szaveri avatar Jul 07 '17 12:07 szaveri

api is documented with openAPI now, closing

rolandgeider avatar Nov 26 '23 17:11 rolandgeider