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

docs(TaskProcessingApi): Cleanup endpoint descriptions #45354

Merged

Conversation

provokateurin
Copy link
Member

Summary

Removed unnecessary information and made the descriptions more expressive:

  1. It is clear the description is about and endpoint
  2. It is also clear that the endpoints act as the current user (as any endpoint does unless it is a public page or has a userId parameter)

Checklist

Signed-off-by: provokateurin <kate@provokateurin.de>
Signed-off-by: provokateurin <kate@provokateurin.de>
@provokateurin provokateurin added the 3. to review Waiting for reviews label May 16, 2024
@provokateurin provokateurin added this to the Nextcloud 30 milestone May 16, 2024
Copy link
Member

@marcelklehr marcelklehr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't understand the motivation for such changes to be honest, but be my guest.

@provokateurin
Copy link
Member Author

It's easier to read and comprehend what is going on 🤷‍♀️ Cleaner docs are always helpful

@provokateurin provokateurin enabled auto-merge May 16, 2024 11:00
Signed-off-by: provokateurin <kate@provokateurin.de>
Signed-off-by: provokateurin <kate@provokateurin.de>
@provokateurin provokateurin force-pushed the docs/taskprocessingapi/cleanup-endpoint-descriptions branch from b15ff8b to a8abe9d Compare May 16, 2024 13:17
@provokateurin provokateurin merged commit 7bc4ccb into master May 16, 2024
155 checks passed
@provokateurin provokateurin deleted the docs/taskprocessingapi/cleanup-endpoint-descriptions branch May 16, 2024 18:09
@blizzz blizzz mentioned this pull request Jul 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
3. to review Waiting for reviews
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants