Communicate supported OOAPI and consumer versions within an api request.
Version
v5
Usecase
Within the MBO OKE project, all systems need to support multiple versions of a consumer. The consequence is that systems need to be able to communicate what versions they support.
Since OOAPI verisoning and consumer versioning are separate processes, both the OOAPI and consumer versiond needs to be addressed.
Which institutions support this change?
No response
Proposed solution
Following assumptions have been made:
We need a solution for both ooapi version and consumer version in one request / response
Number of consumers is limited to one per request/response
We want to stay close to existing web standards
Solution must be as simple, sustainable and clear as possible
Proposed solution:
Use Accept and Content-Type headers
A custom mimetype could be used: application/vnd.ooapi+json
N.B.
It is essential make agreements about communicating the consumer name within a request. However, this is not part of this proposal, it will/needs to be addressed in a separate proposal.
Accept header mime types may use the q parameter for weighting, as commonly used and according to web standards.
Requests and responses
No response
What is your question for the OOAPI work group?
Could the OOAPI work group keep the MBO OKE project informed about this issue?
Organization
Netwerk Examinering Digitalisering
Project
NED-OOAPI - MBO OKE
Contact Details
No response
Short description
Communicate supported OOAPI and consumer versions within an api request.
Version
v5
Usecase
Within the MBO OKE project, all systems need to support multiple versions of a consumer. The consequence is that systems need to be able to communicate what versions they support.
Since OOAPI verisoning and consumer versioning are separate processes, both the OOAPI and consumer versiond needs to be addressed.
Which institutions support this change?
No response
Proposed solution
Following assumptions have been made:
Proposed solution: Use Accept and Content-Type headers A custom mimetype could be used:
application/vnd.ooapi+jsonOOAPI version 5 example
OOAPI and consumer version examples:
N.B. It is essential make agreements about communicating the consumer name within a request. However, this is not part of this proposal, it will/needs to be addressed in a separate proposal. Accept header mime types may use the q parameter for weighting, as commonly used and according to web standards.
Requests and responses
No response
What is your question for the OOAPI work group?
Could the OOAPI work group keep the MBO OKE project informed about this issue?