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

REST API - Deleting files - Improve the documentation #838

Open
1 of 3 tasks
AurelienVasseur opened this issue Jul 29, 2021 · 2 comments
Open
1 of 3 tasks

REST API - Deleting files - Improve the documentation #838

AurelienVasseur opened this issue Jul 29, 2021 · 2 comments

Comments

@AurelienVasseur
Copy link

New Feature / Enhancement Checklist

This is a tiny modification.

The following section in the documentation (https://docs.parseplatform.org/rest/guide/#deleting-files) isn't clear.
I lost almost 1 hour to understand how I must format the file's URL to send the DELETE request.
I found the solution in another GitHub issue (parse-community/parse-server#1765 (comment)) so I'm not the only one who lost time because of that.

Feature / Enhancement Description

The documentation can be improved quickly by adding a clear example to explain how to format the URL.

For example :

Although the file's URL is 'http:////YOUR.PARSE-SERVER.HERE/parse/files/appId/my_picture.png', you have to remove the '/appId' section from the URL to access the API endpoind.

So the URL must be : 'http:////YOUR.PARSE-SERVER.HERE/parse/files/my_picture.png'

Otherwise it will not work.

@AurelienVasseur
Copy link
Author

I would like to submit a PR by myself to update the documentation but I didn't find the project / files of the doc 😞

@mtrezza
Copy link
Member

mtrezza commented Jul 29, 2021

Thanks for suggesting! The docs are in a separate repo. I will transfer this issue to the docs repo.

@mtrezza mtrezza transferred this issue from parse-community/parse-server Jul 29, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants