parse-community / parse-community/docs

REST API - Deleting files - Improve the documentation

Open
#838 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

docs:rest type:docs
Dominant language
SCSS
Stars
317
Forks
507
PR merge metrics
No merged PRs in 30d

Description

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.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Open the REST guide's “Deleting files” section at the documented anchor and compare its current instructions with the linked issue comment. Add a clear example showing the file URL format required for the DELETE endpoint, including the relevant path difference. Done means a reader can determine the correct URL without searching another issue.

Written by the indexing model from the issue text.

Assessment

Domain
api, documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.