Changelogs / API history web widget - issues #2554
AnRei123
started this conversation in
Feature request
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
-
Bug description/Expected behavior
On the API details page, in the header, there is the link "changelogs". If you open this link, you can display the API History web widget to show the changelogs that have been submitted from the APIM portal for a selected API version. The name of the selected API is displayed in title format on top of the API history widget. BUT the information about the currently selected API version is missing. Also an option to quickly switch to the changelogs of a newer or older version is missing in this widget.
When modifying an existing changelog in the APIM portal for a dedicated API version, I saw that the text was properly updated, but the update date remained the same as the creation date. Shouldn´t the update date indicate when the changelog has been modified after initial creation the last time?
In the API History widget only the the column title "Release date" appears, but I miss here an additional column as in the APIM portal with the "Update date" in case a comment for a release has been revised at a later point of time. Or it would also good if someone could add additional log entries for announcements, for example, when the currently selected revision has been decided to be deprecated. So the title "Release date" is not really properly fitting for such cases. I would prefer to rename the title to "Log date" which would be more generic. If the log note is about a newly released revision someone could add this in the description/note column.
I do also miss an option to easily add a log entry at any time, for example, if the display name has been changed or if the deprecation status of an API version has been changed. Or if there is a recommendation about a preferred successor.
It should be possible to add a changelog without creating a new revision in case of communicating the change of display names, updating the descriptions or to announce the deprecation deadline for a previous version at a certain point of time.
It should also be possible to create deep links to the change history page from automatically generated eMail-notifications for a dedicated api version - also via AAD sign-in for managed portals.
For example, in case of breaking changes that are introduced by a new version, the revision history in the changelogs should be updated with the associated reference information and the rational why as of now we recommend to only use the more current version or another API at all.
Is your portal managed or self-hosted?
Managed
Environment
Additional context
We would like to start using this field in future more frequently and we also like to add here further meta / organizational information on API deprecation deadlines and successors. Would the changelog function continued and further improved from you regarding such use cases?
Beta Was this translation helpful? Give feedback.
All reactions