OAI / OAI/OpenAPI-Specification
Add support for "changelog" in the "info" object
Nessuno ha ancora preso questa issue.
- Lingua principale
- Markdown
- Stelle
- 31.2k
- Fork
- 9.2k
- Merge medio
- 6h 37m
- PR unite (30g)
- 27
Descrizione
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.
Guida per i contributori
Apri la guida per i contributori
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.
Direzione di ricerca
Inizia individuando la definizione dell’oggetto info di OpenAPI e la documentazione o gli esempi che descrivono i suoi campi opzionali. Esamina la cronologia dei commenti per verificare l’accordo sull’aggiunta di changelog; il lavoro sarà completato quando sarà stata accettata una modifica della specifica che definisca la proprietà opzionale e il suo valore previsto.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Ambito
- api, documentation
- Tipo di issue
- Funzionalità
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 35/100