REST API - Deleting files - Improve the documentation
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 1/5
- Tempo stimato
- Meno di un'ora
- Idoneità per principianti
- 45/100
- Tipo di issue
- Documentazione
- Chiarezza
- Specificata chiaramente
- Stato di attività
- Ferma
- Ambito
- api, documentation
Direzione di ricerca
Apri la sezione “Deleting files” della guida REST all’ancora documentata e confronta le istruzioni attuali con il commento dell’issue collegata. Aggiungi un esempio chiaro che mostri il formato dell’URL del file richiesto per l’endpoint DELETE, inclusa la differenza rilevante nel percorso. Il lavoro è completato quando un lettore può determinare l’URL corretta senza cercare un’altra issue.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
New Feature / Enhancement Checklist
- I am not disclosing a vulnerability.
- 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.
- Lingua principale
- SCSS
- Stelle
- 317
- Fork
- 506
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Guida per i contributori
Nessuna guida per i contributori indicizzata per questo repository
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di parse-community/docs
-
📙 Apertadocs:cloud-code type:docs
Difficoltà 1/5 1-3 ore Idoneità per principianti 72/100
parse-community/docs#936 ·
-
type:bug
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
parse-community/docs#889 · 7 commenti ·
-
docs:sdk-js
Difficoltà 2/5 1-3 ore Idoneità per principianti 48/100
parse-community/docs#961 ·
-
type:bug
Difficoltà 4/5 3-5 giorni Idoneità per principianti 25/100
parse-community/docs#950 · 2 commenti ·
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 35/100
parse-community/docs#947 ·
Tutte le issue di parse-community/docs
Issue simili
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
use-agent-os/agent-os#3312 ·
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 85/100
-
needs-acceptance wg/data-plane-networking
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
vllm-project/semantic-router#4024 · 1 commento ·
-
bug good first issue
Difficoltà 2/5 1-3 ore Idoneità per principianti 88/100
amponce/archive-movie-browser#165 ·
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100