Content (In Review)
Adds extra content fields to OCTO Core object schemas on select endpoints to provide detailed descriptive information about supplier, products, options, units, booking, etc.
This new proposed capability is currently undergoing Member and Public review.
We'd love to hear your feedback on this draft! Use the #content-capability-development channel on OCTO Slack, or comment on on the draft here:
https://docs.google.com/spreadsheets/d/12bAjNcmW92ZIsghLNfDlpuZALzO7GLkOODWrocu3sic/edit?usp=sharing
To use this capability add octo/content
to your Octo-Capabilities
header.
This capability extends the Supplier, Product, Option, Unit, Availability and Booking schemas to add additional descriptive content that can be used to populate product listings as well as for various for other use cases that require this information.
Localization
Since suppliers and their systems may offer content in different languages, this content capability supports localization through Accept-Language
request header as well as Content-Language
and Available-Languages
response headers as described below.
Request Headers
-
Accept-Language
Optional
This optional request header allows to specify preferred languages for content in the response.
Response Headers
-
Content-Language
Required with octo/content
This header indicates the language of the content fields provided in the response.
To retrieve content in multiple languages, separate requests must be made.
Available-Languages
This header lists all the languages in which content is available, helping clients understand available language options without additional requests.
Also following BCP 47 standards (e.g., en-US
, fr-CA
, es-ES
),
This header is commonly used in APIs, but is non-standard HTTP header.
Additional Content Fields
Content capability enriches existing OCTO Core Supplier, Product, Option, Unit, Availability, and Booking objects with additional information listed below when octo/content
is added to the Octo-Capabilities
the header of the request of any OCTO Core endpoint containing this object, given that the supplier system supports this capability.
See the list of proposed fields in the Google Sheet below. The updated OpenAPI file with the proposed content fields will be published in the coming weeks.
https://docs.google.com/spreadsheets/d/12bAjNcmW92ZIsghLNfDlpuZALzO7GLkOODWrocu3sic/edit?gid=478235837#gid=478235837
Last updated