Open chseifert opened 9 years ago
Shouldn't that wiki entry cover this questions, or do you think it should be explained in more detail? https://github.com/EEXCESS/eexcess/wiki/Request-and-Response-format-for-call-to-federated-recommender-and-privacy-proxy
(just seen that the favicon call is missing, i will add that now)
I think this wiki entry is part of it. But it does not show the complete picture. How do I know that I have to look at this specifiic wiki page, or more generally, that the recommender is the central point of access? And the entitiy service api is not part of the recommender. So, I guess, it is more an overview (and link collection) page we are looking for.
Maybe an "how to start" with a simple example would be helpful, too.
There are always two important parts of a documentation:
For example AngularJS works that way (learn, develop, discuss).
The page mentioned by Hermann is related to formats. I think you should keep the description of the formats and the description of the API (calls) separate. I started to do it for the privacy proxy: https://github.com/EEXCESS/eexcess/wiki/The-Privacy-Proxy-Services. I still need to add the descriptions for getPartnerFavIcon and getPreviewImage. I agree with Christin and Michael: an overview page and a step-by-step tutorial would be useful.
Edit: My bad, Hermann. I just realised that the services are also described in the page you mentioned.
Started it here https://github.com/EEXCESS/eexcess/wiki/Getting-Started-Guide-for-Client-Developers
example files used: (no json upload allowed) simple-request.json.txt first-response.json.txt
When talking to potential developers of new clients, the issue of the "hidden" documentation often occurs. A client developer would need
Basically, this documentation could be like a white paper for developers. This issue aims at first collecting requirements and possible content. So I start with this:
Server Calls (afaik)
Notation: