foojayio / foojayio/discoapi

Clarify API version lifecycle

Ouverte
#55 7 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Langage dominant
Java
Étoiles
154
Forks
18
Métriques de merge des PR
Aucune PR mergée en 30 j

Description

I just noted that the swagger ui points to version 3.0. Is this already in production? The README.MD refers to 2.0 only.

As a API consumer it would be very helpful to have an lifecycle statement which lists available versions with status and EOL date.

Thx for the great work!

Guide de contribution

Aucun guide de contribution indexé pour ce dépôt

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Comparez la version affichée dans Swagger UI avec la référence 2.0 de README.MD, puis examinez la documentation du dépôt concernant les versions de l’API. Le travail est considéré comme terminé lorsque la documentation répertorie clairement chaque version disponible, son statut et sa date de fin de vie, y compris la relation entre les versions 2.0 et 3.0.

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é
2/5
Temps estimé
1-3 heures
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
45/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.