Skip to content

Conversation

@nickvergessen
Copy link
Member

Summary

In order to get closer to OpenAPI all controllers should be up to the state of art how to defining the parameters so they are documented.

Checklist

@nickvergessen nickvergessen added this to the Nextcloud 26 milestone Jan 18, 2023
@nickvergessen nickvergessen requested review from a team, PVince81 and provokateurin January 18, 2023 11:46
@nickvergessen nickvergessen self-assigned this Jan 18, 2023
@nickvergessen nickvergessen requested review from ArtificialOwl and icewind1991 and removed request for a team January 18, 2023 11:46
@provokateurin
Copy link
Member

Shouldn't the parameters also be documented in the comment with explanations?

@nickvergessen nickvergessen force-pushed the techdebt/noid/define-parameters-of-federated-file-sharing branch from c7ca1b4 to 36e5a37 Compare January 18, 2023 11:48
@nickvergessen
Copy link
Member Author

Shouldn't the parameters also be documented in the comment …

Did that, just repushed because I forgot it on the first method

… with explanations?

Not sure I'm fully qualified to provide this.

@provokateurin
Copy link
Member

Explanations could be copied from https://github.com/cs3org/OCM-API/blob/develop/spec.yaml

@provokateurin
Copy link
Member

It also doesn't matter too much right now, I'd just copy them later

@nickvergessen
Copy link
Member Author

Closing for now as it's the wrong endpoint

@provokateurin
Copy link
Member

This is relevant now. I reopened because I would have just created the same PR again.

@provokateurin provokateurin force-pushed the techdebt/noid/define-parameters-of-federated-file-sharing branch from 36e5a37 to 7819975 Compare June 14, 2023 07:23
@provokateurin provokateurin force-pushed the techdebt/noid/define-parameters-of-federated-file-sharing branch from 7819975 to bf4c5bd Compare June 14, 2023 12:54
@provokateurin provokateurin enabled auto-merge June 14, 2023 13:08
@provokateurin provokateurin merged commit bfeb741 into master Jun 14, 2023
@provokateurin provokateurin deleted the techdebt/noid/define-parameters-of-federated-file-sharing branch June 14, 2023 14:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants