Skip to content

Comments

switch index to ocs#829

Merged
Pytal merged 9 commits intomasterfrom
ocs
Jan 7, 2025
Merged

switch index to ocs#829
Pytal merged 9 commits intomasterfrom
ocs

Conversation

@tobiasKaminsky
Copy link
Member

@tobiasKaminsky tobiasKaminsky commented Dec 12, 2024 •
edited
Loading

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
ChristophWurst
ChristophWurst previously requested changes Dec 12, 2024
View reviewed changes
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

ChristophWurst commented Dec 12, 2024

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

nickvergessen
nickvergessen reviewed Dec 12, 2024
View reviewed changes
@tobiasKaminsky tobiasKaminsky mentioned this pull request Dec 12, 2024
Merged
@provokateurin
Copy link
Member

provokateurin commented Dec 17, 2024

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

tobiasKaminsky commented Dec 18, 2024

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 provokateurin marked this pull request as ready for review December 19, 2024 07:47
@provokateurin
Copy link
Member

provokateurin commented Dec 19, 2024

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

provokateurin commented Dec 19, 2024

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

provokateurin commented Dec 19, 2024

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

ChristophWurst commented Dec 19, 2024

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

provokateurin commented Dec 19, 2024

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

@provokateurin provokateurin mentioned this pull request Dec 22, 2024
Open
come-nc
come-nc reviewed Jan 7, 2025
View reviewed changes
@provokateurin provokateurin requested a review from come-nc January 7, 2025 14:35
@provokateurin
Copy link
Member

provokateurin commented Jan 7, 2025

/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
@provokateurin @Pytal
style: Indent composer.json correctly
af4e0f1 
Signed-off-by: provokateurin <[email protected]>
Signed-off-by: Christopher Ng <[email protected]>
@provokateurin @Pytal
fix(deps): Add nextcloud/ocp
e77ce38 
Signed-off-by: provokateurin <[email protected]>
Signed-off-by: Christopher Ng <[email protected]>
@provokateurin @Pytal
build: Add composer bin plugin
c441ca3 
Signed-off-by: provokateurin <[email protected]>
Signed-off-by: Christopher Ng <[email protected]>
@provokateurin @Pytal
build: Add psalm
8fe3839 
Signed-off-by: provokateurin <[email protected]>
Signed-off-by: Christopher Ng <[email protected]>
@provokateurin @Pytal
build: Add openapi-extractor
82dddc5 
Signed-off-by: provokateurin <[email protected]>
Signed-off-by: Christopher Ng <[email protected]>
@provokateurin @Pytal
fix(psalm): Enable OpenAPI rules
89e9c2c 
Signed-off-by: provokateurin <[email protected]>
Signed-off-by: Christopher Ng <[email protected]>
@provokateurin @Pytal
refactor(RecommendationController): Migrate to OCS
2b3db5b 
Signed-off-by: provokateurin <[email protected]>
Signed-off-by: Christopher Ng <[email protected]>
@tobiasKaminsky @Pytal
feat(App): Add Capabilities
cff1795 
Signed-off-by: provokateurin <[email protected]>
Signed-off-by: Christopher Ng <[email protected]>
@nextcloud-command @Pytal
chore(assets): Recompile assets
782ef58 
Signed-off-by: nextcloud-command <[email protected]>
Signed-off-by: Christopher Ng <[email protected]>
@Pytal Pytal merged commit d26946f into master Jan 7, 2025
44 checks passed
@Pytal Pytal deleted the ocs branch January 7, 2025 23:54
@blizzz blizzz mentioned this pull request Jan 8, 2025
Merged
@provokateurin provokateurin mentioned this pull request Jan 25, 2025
Merged
This was referenced Mar 23, 2025
Closed
Closed
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@provokateurin provokateurin provokateurin left review comments

@Pytal Pytal Pytal approved these changes

@come-nc come-nc come-nc approved these changes

@ChristophWurst ChristophWurst Awaiting requested review from ChristophWurst

@nickvergessen nickvergessen Awaiting requested review from nickvergessen

Assignees

No one assigned

Labels

2. developing enhancement New feature or request pending documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Have index route available for client via OCS

7 participants

@tobiasKaminsky @ChristophWurst @provokateurin @Pytal @nickvergessen @come-nc @nextcloud-command