Documenting `cat` with an example in Apiary
Personne n'a encore pris cette issue.
Évaluation
- Difficulté
- 3/5
- Temps estimé
- 1-2 jours
- Accessibilité débutants
- 30/100
- Type d'issue
- Documentation
- Clarté
- À clarifier
- Activité
- À l'abandon
- Domaine
- api, documentation
Piste de recherche
Commencez par l’exemple /api/v0/cat dans Apiary et comparez la réponse curl affichée avec le PR 1776 de go-ipfs indiqué. Clarifiez la sortie attendue ainsi que les en-têtes MIME et de transfert, puis mettez à jour la documentation Apiary afin que l’exemple décrive correctement cat.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
I'm unsure how to document this adequately.
$ curl -i http://localhost:5001/api/v0/cat?arg=QmeomffUNfmQy76CQGy9NdmqEnnHU9soCexBnGU3ezPHVH
HTTP/1.1 200 OK
Content-Length: 5
Transfer-Encoding: chunked
X-Stream-Output: 1
test
What is the output of a cat command? What is the mime-type of a chunked file? I don't know, and I'm having difficulty googling it.
Further, cat shouldn't return both content-length and transfer-encoding. See https://github.com/ipfs/go-ipfs/pull/1776 for more on that.
- Langage dominant
- API Blueprint
- Étoiles
- 2
- Forks
- 0
- Métriques de merge des PR
- Aucune PR mergée en 30 j
Préparer son environnement
Ce projet ne fournit ni conteneur de développement, ni Dockerfile, ni guide de contribution : l'installation est à votre charge. Commencez par son README, et consultez notre guide de la première contribution pour les étapes générales.
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Issues similaires
-
auto:producer auto:security
Difficulté 2/5 1-3 heures Accessibilité débutants 66/100
fritzprix/libr-agent#2595 ·
Les mainteneurs répondent en général sous 1 jour
-
Non-root first start logs "Base venv updated (stamp mismatch)" instead of the first-run messageOuvertearea: infrastructure bug priority: low
Difficulté 2/5 1-3 heures Accessibilité débutants 78/100
snapotter-hq/SnapOtter#4573 ·
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 1-3 heures Accessibilité débutants 76/100
-
Difficulté 2/5 1-3 heures Accessibilité débutants 83/100
-
comp: ssr comp: zones type: feature version: current (v17+)
Difficulté 2/5 1-3 heures Accessibilité débutants 84/100
angular/angularfire#3836 ·
Les mainteneurs répondent en général sous 3 jours