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

switch index to ocs #829

Merged
merged 9 commits into from
Jan 7, 2025
Merged

switch index to ocs #829

merged 9 commits into from
Jan 7, 2025

Conversation

tobiasKaminsky
Copy link
Member

@tobiasKaminsky tobiasKaminsky commented Dec 12, 2024

Fix #828

  • webfrontend generates url with "index.php" and thus does not work.

@ChristophWurst ChristophWurst requested a review from Pytal December 12, 2024 07:47
Copy link
Member

@ChristophWurst ChristophWurst left a 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

  1. Manually document the endpoints.
  2. 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.

@ChristophWurst
Copy link
Member

Please also see #458. I think the two PRs have the same goal.

src/service/RecommendationService.js Outdated Show resolved Hide resolved
src/service/RecommendationService.js Outdated Show resolved Hide resolved
@provokateurin
Copy link
Member

While you're on this anyway, how about adding https://github.com/nextcloud/openapi-extractor support?
Given the small API surface it shouldn't take much time, but I can also do that for you if you want.

@tobiasKaminsky
Copy link
Member Author

Given the small API surface it shouldn't take much time, but I can also do that for you if you want.

That would be wonderful 💙

@provokateurin
Copy link
Member

I tried to keep the changes as minimal as possible. Another good cleanup would be to migrate the annotations and routes to attributes.

@provokateurin
Copy link
Member

Meh more things to fix

@provokateurin provokateurin marked this pull request as draft December 19, 2024 07:51
@provokateurin provokateurin marked this pull request as ready for review December 19, 2024 08:04
@provokateurin
Copy link
Member

OCI test fails are unrelated, the container image that is used no longer works.
Maintainers should switch to the phpunit templates from the org.

@ChristophWurst
Copy link
Member

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.

@provokateurin
Copy link
Member

Yes it matches the docs, at least if I understand them correctly.

psalm.xml Outdated Show resolved Hide resolved
psalm-baseline.xml Show resolved Hide resolved
@provokateurin
Copy link
Member

/compile

@Pytal
Copy link
Member

Pytal commented Jan 7, 2025

OCI test fails are unrelated, the container image that is used no longer works. Maintainers should switch to the phpunit templates from the org.

Done #834

provokateurin and others added 9 commits January 7, 2025 15:50
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>
@Pytal Pytal merged commit d26946f into master Jan 7, 2025
44 checks passed
@Pytal Pytal deleted the ocs branch January 7, 2025 23:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Have index route available for client via OCS
7 participants