Add support for "changelog" in the "info" object
Les mainteneurs répondent en général sous 1 jour
Personne n'a encore pris cette issue.
Évaluation
- Difficulté
- 5/5
- Temps estimé
- Plus d'une semaine
- Accessibilité débutants
- 35/100
- Type d'issue
- Fonctionnalité
- Clarté
- Plutôt claire
- Activité
- À l'abandon
- Domaine
- api, documentation
Piste de recherche
Commencez par localiser la définition de l’objet info d’OpenAPI ainsi que la documentation ou les exemples qui décrivent ses champs facultatifs. Consultez l’historique des commentaires pour vérifier qu’il existe un accord sur l’ajout de changelog ; le travail sera considéré comme terminé lorsqu’une modification de spécification acceptée définira la propriété facultative et sa valeur attendue.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
When maintaining an API specification, it would be really nice to offer a changelog for the API consumer. This can be as simple as a link to a changelog.
Possible Solution
The info object seems to be the most suitable place that such a parameter could be located (as an optional parameter).
Example:
info:
version: 1.1.0
title: My API Specification
changelog: https://acme.com/docs/api/v1/changelog.md
Nb: I know that this is currently possible via x- extension, yet not all tools seem to accept extensions.
- Langage dominant
- Markdown
- Étoiles
- 31.2k
- Forks
- 9.2k
- Merge moyen
- 2 j 9 h
- PR mergées (30 j)
- 17
Préparer son environnement
- Aucun Dockerfile ni fichier Docker Compose
- Propose un modèle de pull request
- Lire 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.
Autres issues de OAI/OpenAPI-Specification
-
Housekeeping
Difficulté 1/5 Moins d'une heure Accessibilité débutants 45/100
OAI/OpenAPI-Specification#5566 ·
Les mainteneurs répondent en général sous 1 jour
-
Housekeeping
Difficulté 1/5 Moins d'une heure Accessibilité débutants 35/100
OAI/OpenAPI-Specification#5562 · 4 commentaires ·
Les mainteneurs répondent en général sous 1 jour
-
Housekeeping
Difficulté 5/5 Plus d'une semaine Accessibilité débutants 10/100
OAI/OpenAPI-Specification#5556 · 3 commentaires ·
Les mainteneurs répondent en général sous 1 jour
-
v3.2.1 releasePeut-être à nouveau libre @lornajane l’a pris il y a 33 jours, et aucune pull request n’est ouverte. Ouverte
OAI/OpenAPI-Specification#5460 · 11 commentaires · 1 réaction · 1 personne assignée ·
Les mainteneurs répondent en général sous 1 jour
-
param serialization
Difficulté 5/5 Plus d'une semaine Accessibilité débutants 25/100
OAI/OpenAPI-Specification#5366 · 12 commentaires ·
Les mainteneurs répondent en général sous 1 jour
Toutes les issues de OAI/OpenAPI-Specification
Issues similaires
-
Difficulté 2/5 1-3 heures Accessibilité débutants 82/100
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 1-3 heures Accessibilité débutants 70/100
onyx-dot-app/onyx#16016 ·
Les mainteneurs répondent en général sous 1 jour
-
reproduced
Difficulté 2/5 1-3 heures Accessibilité débutants 72/100
anomalyco/opencode#55369 · 1 commentaire ·
Les mainteneurs répondent en général sous 1 jour
-
feature
Difficulté 2/5 1-3 heures Accessibilité débutants 60/100
manyfold3d/manyfold#7346 · 1 commentaire ·
Les mainteneurs répondent en général sous 1 jour
-
bug
Difficulté 2/5 1-3 heures Accessibilité débutants 62/100
chaitin/agent-compose#770 ·
Les mainteneurs répondent en général sous 1 jour