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

Improve API documentation #3455

Merged
merged 10 commits into from
Apr 27, 2024
Merged

Improve API documentation #3455

merged 10 commits into from
Apr 27, 2024

Conversation

Bagoult
Copy link
Contributor

@Bagoult Bagoult commented Apr 25, 2024

Hello! I improved the documentation of the REST-API to make it easier for future users. Here is what it does:

  • Refreshes outdated information (deleted field is now a boolean, share_api#add endpoint was changed recently).
  • Completes sections about payloads, and creates separate sections to give example of possible return values. (This way, the reader knows which fields appear in the return value, but shouldn't appear in the payload.)
  • Explains a few things that I found confusing the first time I came across them (ex: sending "expire": 0 doesn't remove the current expiration date, but sets it to 0).
  • Another curl example to show how to create a new poll.

@dartcafe
Copy link
Collaborator

Awesome. Great work. Unfortunately the structures are still subject of changing. Especially the update poll method needs some more work, since I plan to change the structure and differentiate between read only properties and properties wich can be changed.

@dartcafe dartcafe self-requested a review April 26, 2024 06:21
docs/API_v1.0.md Outdated Show resolved Hide resolved
@dartcafe
Copy link
Collaborator

And, it would be good if you could sign your commits.

@dartcafe dartcafe added this to the 7.1 milestone Apr 26, 2024
@dartcafe dartcafe self-requested a review April 26, 2024 12:59
@dartcafe
Copy link
Collaborator

Give me a hint, when you are finished. And thanks a lot, there were really a lot of missing things and broken docs.

Copy link
Collaborator

@dartcafe dartcafe left a comment

Choose a reason for hiding this comment

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

Great so far.

artonge and others added 9 commits April 26, 2024 20:32
Signed-off-by: Bagout <firefox.zmcgq@aleeas.com>
Signed-off-by: Bagout <firefox.zmcgq@aleeas.com>
Signed-off-by: Bagout <firefox.zmcgq@aleeas.com>
Acl
Add a description of "acl" endpoint

Signed-off-by: Bagout <firefox.zmcgq@aleeas.com>
Added examples of payload and return values for public, user and email shares

Signed-off-by: Bagout <firefox.zmcgq@aleeas.com>
Signed-off-by: Bagout <firefox.zmcgq@aleeas.com>
Signed-off-by: Bagout <firefox.zmcgq@aleeas.com>
Endpoints for close and reopen
Meaning of a "0" expiration timestamp

Signed-off-by: Bagout <firefox.zmcgq@aleeas.com>
Signed-off-by: Nextcloud bot <bot@nextcloud.com>
Signed-off-by: Bagout <firefox.zmcgq@aleeas.com>
@Bagoult
Copy link
Contributor Author

Bagoult commented Apr 26, 2024

Everything should be signed off now and ready to merge @dartcafe :)

@dartcafe
Copy link
Collaborator

@Bagoult Ah. And a rebase is not really necessary until you don't need the current target branch for testing your build.

@dartcafe dartcafe merged commit 8863ba7 into nextcloud:master Apr 27, 2024
15 checks passed
Copy link

Hello there,
Thank you so much for taking the time and effort to create a pull request to our Nextcloud project.

We hope that the review process is going smooth and is helpful for you. We want to ensure your pull request is reviewed to your satisfaction. If you have a moment, our community management team would very much appreciate your feedback on your experience with this PR review process.

Your feedback is valuable to us as we continuously strive to improve our community developer experience. Please take a moment to complete our short survey by clicking on the following link: https://cloud.nextcloud.com/apps/forms/s/i9Ago4EQRZ7TWxjfmeEpPkf6

Thank you for contributing to Nextcloud and we hope to hear from you soon!

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.

None yet

4 participants