[jbossts-issues] [JBoss JIRA] (JBTM-3294) Include a custom HTTP LRA version header on REST calls made by our implementation

[ https://issues.redhat.com/browse/JBTM-3294?page=com.atlassian.jira.plugin... ] Ondrej Chaloupka edited comment on JBTM-3294 at 5/20/20 10:08 AM: ------------------------------------------------------------------ We've discussed the aspects of the REST api versioning related to LRA concept within the team. For the version will be used a custom header with version in format {{<major>.<minor>}}. Where we expect for a breaking change having a new {{<major>}} version. {{<minor>}} version is to be used for addition and other API changes which does not make compatibility issue. There should be supported at least three versions (the new and the old ones) of API in parallel. The api will be documented with Swagger/OpenAPI (as it already is) and we should find a proper place where to place the API description (probably at http://narayana.io) was (Author: ochaloup): We've discussed the aspects of the REST api versioning related to LRA concept in the team. For the version will be used a custom header with version in format {{<major>.<minor>}}. Where we expect for a breaking change having a new {{<major>}} version. {{<minor>}} version is to be used for addition and other API changes which does not make compatibility issue. There should be supported at least three versions (the new and the old ones) of API in parallel. The api will be documented with Swagger/OpenAPI (as it already is) and we should find a proper place where to place the API description (probably at http://narayana.io) -- This message was sent by Atlassian Jira (v7.13.8#713008)