Include dev API in docs
Ouverte
Personne n'a encore pris cette issue.
cloud/server
- Langage dominant
- Vue
- Étoiles
- 15
- Forks
- 22
- Merge moyen
- 5 j 11 h
- PR mergées (30 j)
- 9
Description
if we have swagger definition of the public REST API it should be possible to easily create nice documentation for anyone who would like to use it for custom integrations
Guide de contribution
Ouvrir le guide de contribution
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.
Piste de recherche
L’issue identifie la REST API publique et une définition Swagger, mais ne nomme aucun fichier ni point d’entrée. Commencez par localiser la spécification de l’API et les points d’intégration du site de documentation ; la tâche est terminée lorsque l’API publique est documentée sous une forme facile à utiliser pour des intégrateurs personnalisés.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- openapi
- Domaine
- api, documentation
- Type d'issue
- Documentation
- Difficulté
- 4/5
- Temps estimé
- 3-5 jours
- Activité
- À l'abandon
- Clarté
- À clarifier
- Accessibilité débutants
- 25/100