Please DO NOT rely on what you see in this github repository. To best of my understanding it is not maintained consistently.
The only official and reliable way to get the Open API data model is via the published swaggers (v4)/OAS (v5) in the Open API directory here: https://www.tmforum.org/oda/open-apis/directory
There have been plans to make the Open API data model itself a published and supported asset, but I have no visibility about if and when this will happen.
Any opinions and statements made by me on this forum are purely personal, and do not necessarily reflect the position of the TM Forum or my employer.
Original Message:
Sent: Aug 02, 2024 11:13
From: Graham Agnew
Subject: TMF APIs Schema
There *is* a repository on Github which has a lot of the APIs, and also a fairly nicely structured set of schemas. The nice part is that things that share common patterns in the schema definitions are split out into the schemas/Common subdirectory; there isn't the repeated definition of something like an entity reference which is a very common pattern across many of the schemas. The swagger files have these definitions flattened out, leading to a lot of repetition.
https://github.com/tmforum-apis/Open_Api_And_Data_Model
But I don't know who owns it and it looks fairly dormant. The last commit was April 2023 and there are five open issues, none of which have any replies.
------------------------------
Graham Agnew
CSG Systems, Inc.
Original Message:
Sent: Jul 25, 2024 02:56
From: Jonathan Goldberg
Subject: TMF APIs Schema
Going back to Viswanth's original question, unfortunately there is currently no consolidated publication of the full Open API model.
The published Swagger/OAS files for individual APIs contain schemas that have been post-processed by tooling e.g. by expanding $ref references.
Regarding comparisons - I would suggest that API management tools may have the capabilities that you are looking for, for semantic signature comparison. I would suggest searching vendors or open-source offerings for these capabilities.
Good luck!
------------------------------
Jonathan Goldberg
Amdocs Management Limited
Any opinions and statements made by me on this forum are purely personal, and do not necessarily reflect the position of the TM Forum or my employer.
Original Message:
Sent: Jul 24, 2024 03:44
From: Viswanth Venkatesh Govindaraj
Subject: TMF APIs Schema
Yeah, Understand your pov. Trying to list all attributes in excel and compare it with legacy API attributes to highlight missing ones.
Thanks!
Viswanth V.G
------------------------------
Viswanth Venkatesh Govindaraj
Tech Mahindra Limited
Original Message:
Sent: Jul 24, 2024 03:22
From: Alexey Rusakov
Subject: TMF APIs Schema
Excel is far from being an appropriate format for hierarchical structures like API descriptions. I wonder how you intend to use that Excel file - how would that be superior to studying YAML files directly or exploring the APIs in a tool like Postman or Apicurio?
------------------------------
Alexey Rusakov
Red Hat, Inc.
Original Message:
Sent: Jul 23, 2024 04:52
From: Viswanth Venkatesh Govindaraj
Subject: TMF APIs Schema
We are trying to improve BSS stack, which is riddled with legacy REST APIs, SOAs. In order to build TMF compliant APIs, we need to have the data model that our developers can use it.
Right now, we are looking at yaml files and loading them to swagger to understand schema. Is there a way to export all the schema to excel for a given TMF API with all the hierarchies in-tact?
Any help is appreciated.
--
Viswanth V.G
#OpenDigitalArchitecture
------------------------------
Viswanth Venkatesh Govindaraj
------------------------------