APIs have versions. Now we dont have any kind of version management. Swagger files require version information and that should be used here too. API datamodel needs version attribute and valid until attribute (date given by API admin and indicates when API is going to be deprecated).
Add new version
Adding new version for API starts from API detailed view, not from top menu. Admin of the API should see a button "Add new version". In the view owner can start with:
open api spec file or
copy previous API version as draft for new one.
In case of 1. api spec file is used where applicable. For other information, it should be copied from previous API version (metadata, logo, org, etc). Proxy settings should be left empty or if there is a way to generate proper proxy settings automatically then it can be prefilled and API can be connected to proxy.
In case of 2. user has clone of previous API version and needs to replace open api spec file or link other kind of documentation.
Links between versions
When new version for API is added it should be accessible from previous API detailed view (link?). Each version of the same API should have link to other versions. By default new API version will have design phase as lifecycle.
Note
This epic would be related to version management #3117
ilarimikkonen
commented
5 years ago
Description:
APIs have versions. Now we dont have any kind of version management. Swagger files require version information and that should be used here too. API datamodel needs version attribute and valid until attribute (date given by API admin and indicates when API is going to be deprecated).
Add new version
Adding new version for API starts from API detailed view, not from top menu. Admin of the API should see a button "Add new version". In the view owner can start with:
In case of 1. api spec file is used where applicable. For other information, it should be copied from previous API version (metadata, logo, org, etc). Proxy settings should be left empty or if there is a way to generate proper proxy settings automatically then it can be prefilled and API can be connected to proxy.
In case of 2. user has clone of previous API version and needs to replace open api spec file or link other kind of documentation.
Links between versions
When new version for API is added it should be accessible from previous API detailed view (link?). Each version of the same API should have link to other versions. By default new API version will have design phase as lifecycle.
Note
This epic would be related to version management #3117