Openapi-specification: Add support for "changelog" in the "info" object

Created on 13 Nov 2020  路  4Comments  路  Source: OAI/OpenAPI-Specification

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.

Most helpful comment

An alternative would be to allow external doc url to be an array with some pre-defined "types" like changelog.

All 4 comments

I support this idea. Currently, I just put a link in the description, but I think it's important enough to get a new tag and make tooling render it separately, maybe even include it if it's markdown or so.

great idea, however, i usually leverage the external doc url and point "humans" to a url that has supporting documentation of the API (and this includes a URL to a changelog)

Whether or not a "changelog" tag should support an url as value or somehow include the entire content (e.g. via markdown), is perhaps of less importance here. Both approaches are acceptable, in my opinion. The important part is to formally support and encourage stating an api's changelog.

An alternative would be to allow external doc url to be an array with some pre-defined "types" like changelog.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

mission-liao picture mission-liao  路  3Comments

ePaul picture ePaul  路  5Comments

rocchisanijl picture rocchisanijl  路  5Comments

jblazek picture jblazek  路  3Comments

john1452 picture john1452  路  5Comments