docs icon indicating copy to clipboard operation
docs copied to clipboard

REST API - Deleting files - Improve the documentation

Open AurelienVasseur opened this issue 4 years ago • 2 comments

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 (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.

AurelienVasseur avatar Jul 29 '21 19:07 AurelienVasseur

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

AurelienVasseur avatar Jul 29 '21 19:07 AurelienVasseur

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

mtrezza avatar Jul 29 '21 21:07 mtrezza