Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation of OCS API #1818

Open
Bibo-Joshi opened this issue Dec 18, 2024 · 0 comments
Open

Documentation of OCS API #1818

Bibo-Joshi opened this issue Dec 18, 2024 · 0 comments

Comments

@Bibo-Joshi
Copy link

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant