Provide field on top level API response indicating API version in use
Background
Copying over from here: https://github.com/CrossRef/rest-api-doc/issues/435
The documentation says that there are different versions of the API that can be referenced, but does not list the current version or available versions anywhere that I can find.
It would be useful to indicate which version of API a response is from for developers. I am developing a new Java client and am wanting to "pin" the version of the API it is querying against for stability reasons, but have no idea what version(s) are acceptable for the versioned API endpoint other than "v1".
It would also be useful when querying against the latest version of the API to be able to test if there is a major version bump by the client code that can be tested against to warn the developer of potential compatibility issues.
Perhaps add such an indicator at the top level along side "status', etc, as:
"api-version": "v1"
Observed behavior
Expected behavior
How urgent
Definition of ready
-
Product owner: @ppolischuk1 -
Tech lead: -
Service:: label applied -
Definition of done updated -
Acceptance testing plan: -
Weight applied
Definition of done
-
Unit tests identified, implemented, and passing -
Code reviewed -
Available for acceptance testing via a staging URL, or otherwise -
Consider any impacts to current or future architecture/infrastructure, and update specifications and documentation as needed -
Knowledge base reviewed and updated -
Public documentation reviewed and updated -
Acceptance criteria met -
AC 1 -
AC 2
-
-
Acceptance testing passed -
Deployed to production