Documentation of OCS API

Hi there,

We're using the circles app in our musical club for some internal organization. For some automated generation of member lists, I'd like to query data from the circles via http endpoints.

I already found the OCS API endpoints and was able to run some queries on them. However, I did not find a description of how they are intended to be used (e.g. what's the "emulated" parameter in the admin endpoints?) and what the schema of the return value is. I guess they are mostly based on the php models, but aggregating the data from there is a bit of a hassle, especiall if you're not so familiar with php (like me 😅 )

Would it be possible to document the OCS API, maybe in an openAPI json schema, somewhere? I see that there is already some documentation in the wiki.

Thanks for the work!

PS: I chose a blank template b/c I consider this neither bug nor feature request. Please let me know if I should re-open using a template.

Start with appinfo/routes.php and the PHP models under lib/Model, then compare the existing PHP API v1 wiki page. Document the OCS endpoints, including the emulated admin parameter and response schemas; done means consumers can understand how to call the endpoints without reconstructing the models.