Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for "changelog" in the "info" object #2409

Open
aedart opened this issue Nov 13, 2020 · 4 comments
Open

Add support for "changelog" in the "info" object #2409

aedart opened this issue Nov 13, 2020 · 4 comments
Labels
metadata tags, info, license, contact, markdown usage, etc.

Comments

@aedart
Copy link

aedart commented Nov 13, 2020

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.

@m-mohr
Copy link

m-mohr commented Nov 25, 2020

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.

@miqui
Copy link
Contributor

miqui commented Nov 26, 2020

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)

@aedart
Copy link
Author

aedart commented Nov 29, 2020

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.

@m-mohr
Copy link

m-mohr commented Nov 30, 2020

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

@handrews handrews added the metadata tags, info, license, contact, markdown usage, etc. label Jan 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
metadata tags, info, license, contact, markdown usage, etc.
Projects
None yet
Development

No branches or pull requests

4 participants