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

[Michael Musgrove (Jira)]

Michael Musgrove created JBTM-3294:
--------------------------------------

             Summary: Include a custom HTTP LRA version header on REST calls made by our implementation
                 Key: JBTM-3294
                 URL: https://issues.redhat.com/browse/JBTM-3294
             Project: JBoss Transaction Manager
          Issue Type: Enhancement
          Components: LRA
    Affects Versions: 5.10.4.Final
            Reporter: Michael Musgrove
            Assignee: Michael Musgrove
             Fix For: 5.next


Our implementation of the LRA specification exposes REST endpoints whose semantics may change over time. As the LRA spec evolves users will need a guarantee that the endpoints behave consistently.

To avoid introducing breaking changes I propose that we version REST API calls made by the implementation using a version header, something like:

bq. OpenStack-API-Version: narayana LRA 5.10.5.Final

or

bq. OpenStack-API-Version: narayana LRA 5.10.5.Final https://<the location of our OpenAPI document>

I went for the [OpenStack guideline|https://specs.openstack.org/openstack/api-wg/guidelines/headers.html] since it was the only standard I could find for custom headers.

A reason it is narayana specific is that our API offers more than the spec requires.



--
This message was sent by Atlassian Jira
(v7.13.8#713008)