-
Notifications
You must be signed in to change notification settings - Fork 18
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
switch index to ocs #829
switch index to ocs #829
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Dear @tobiasKaminsky,
Thank you very much for the contribution.
This seems to convert the internal API of the app to a public API. To meet the standards of a public API, there has to be documentation about it in the developer documentation of Nextcloud. There are two options for an OCS documentation
- Manually document the endpoints.
- Use the OpenAPI generator to auto-generate a machine-readable metadata file.
Please note that once the API is public, it can no longer change in breaking ways for one year.
Please also see #458. I think the two PRs have the same goal. |
While you're on this anyway, how about adding https://github.com/nextcloud/openapi-extractor support? |
That would be wonderful 💙 |
I tried to keep the changes as minimal as possible. Another good cleanup would be to migrate the annotations and routes to attributes. |
Meh more things to fix |
OCI test fails are unrelated, the container image that is used no longer works. |
Does this API match https://docs.nextcloud.com/server/latest/developer_manual/client_apis/OCS/ocs-recommendations-api.html? These docs were merged prematurely before the integration of #458. |
Yes it matches the docs, at least if I understand them correctly. |
/compile |
Done #834 |
Signed-off-by: provokateurin <kate@provokateurin.de> Signed-off-by: Christopher Ng <chrng8@gmail.com>
Signed-off-by: provokateurin <kate@provokateurin.de> Signed-off-by: Christopher Ng <chrng8@gmail.com>
Signed-off-by: provokateurin <kate@provokateurin.de> Signed-off-by: Christopher Ng <chrng8@gmail.com>
Signed-off-by: provokateurin <kate@provokateurin.de> Signed-off-by: Christopher Ng <chrng8@gmail.com>
Signed-off-by: provokateurin <kate@provokateurin.de> Signed-off-by: Christopher Ng <chrng8@gmail.com>
Signed-off-by: provokateurin <kate@provokateurin.de> Signed-off-by: Christopher Ng <chrng8@gmail.com>
Signed-off-by: provokateurin <kate@provokateurin.de> Signed-off-by: Christopher Ng <chrng8@gmail.com>
Signed-off-by: provokateurin <kate@provokateurin.de> Signed-off-by: Christopher Ng <chrng8@gmail.com>
Signed-off-by: nextcloud-command <nextcloud-command@users.noreply.github.com> Signed-off-by: Christopher Ng <chrng8@gmail.com>
Fix #828