Changes

stoney core: REST API

668 bytes added, 16:42, 11 December 2013
/* REST API documentation */
== REST API documentation ==
There are two types of API calls: * Fully RESTful Ressources and Collections (the default), addressed using "nouns"* Helpers, commands and actions, addressed using "verbs" With this we are following [https://blog.apigee.com/detail/restful_api_design_what_about_responses_that_dont_involve_resources/ a pragmatic API design]. === Auth helper action ===
To give a client the possibility of verifying username and password, a pseudo-ressource is provided, the only method implemented is the GET.
</pre>
(no content for now)
 
=== Search helper ===
 
We want to provide an omni-search/ElasticSearch style search function and the most flexible approach is by doing the search completely on the server-side.
 
Therefore we are gonna copy the leader in search and define the URL for searching this way:
 
<code>https://api.example.com/v1/search?q=fluffy+dragon</code>.
 
 
=== Reseller resource ===
Bureaucrat, administrator
425
edits