Component Specification Release Notes¶
This page shows the ODA Component specification for each release version, with a comparison to the previous version. The ODA Component specification is defined using the Open API Specification v3.
v1 - December 18th 2024¶
This is the general availability version of the component specification. There are no changes since v1beta4.
The OAS Specification can be found at oda-component-oas-v1.yaml.
v1beta4 - October 16th 2024¶
The OAS Specification can be found at oda-component-oas-v1beta4.yaml.
Changes since v1beta3:
eTom,SIDandfunctionalFrameworkwere added to the component spec.The component metadata (
id,name,version,description,functionalBlock,publicationDate,eTom,SID,functionalFramework,maintainers,owners) has been grouped into acomponentMetadataobject.Each
exposedAPIanddependentAPInow has anidTMFxxx (e.g. TMF620 for Product Catalog Management) and aversion. AnexposedAPIordependentAPIcan allow one or more versions of the same API.The
controllerRolewithinsecurityManagementwas renamed tocanvasSystemRole.
v1beta3 - August 12th 2024¶
The OAS Specification can be found at oda-component-oas-v1beta3.yaml.
Feature changes since v1beta2:
In
coreFunction,managementFunctionandsecurityFunction, for every item inexposedAPIsthespecificationnow allows anarraywithminItemsof 1 (instead of a single string). This is to support Components that may expose APIs for different versions of the Open-API specification. It was introduced specifically to support the new TM Forum v5 APIs. A component may implement one or more versions of each API, and the specification will point to the OAS schema for that API.in
securityFunctionthere is a new optional propertysecretsManagement. This allows the author of a component to declare a requirement for a secrets store. If set, the Canvas will configure access to a secrest store (the reference implementation being based on Hashicorp Vault).The
eventNotificationpublishedEventshave additional properties ofdescription,developerUI,hub,implementation,portandspecification. ThesubscribedEventshave additional properties ofcallback,description,developerUI,implementation,port,queryandspecification.
Fixes since v1beta2:
In all
exposedAPIsanddependentAPIs, theapitypeis changed toapiTypeto adopt the correct camelCase format for properties.The
prometheusapiTypeoption has been removed from all areas except in themanagementFunction.exposedAPI(this is the only place where the prometheus option was relavant).
The picture below shows a diff between oda-component-oas-v1beta3.yaml and oda-component-oas-v1beta2.yaml.
