docs
docs copied to clipboard
REST API - Deleting files - Improve the documentation
New Feature / Enhancement Checklist
- [ ] I am not disclosing a vulnerability.
- [x] I am not just asking a question.
- [ ] I have searched through existing issues.
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 (https://github.com/parse-community/parse-server/issues/1765#issuecomment-384546321) 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.
I would like to submit a PR by myself to update the documentation but I didn't find the project / files of the doc 😞
Thanks for suggesting! The docs are in a separate repo. I will transfer this issue to the docs repo.