camaraproject / APIBacklog

Repository to maintain the API Backlog for CAMARA.
https://wiki.camaraproject.org/x/I4tF
Apache License 2.0
8 stars 20 forks source link

API Classification #6

Closed marc196 closed 3 years ago

marc196 commented 3 years ago

API classification is a correct approach if Class are mutually exclusive. May be that it is not the case. Different points of view may bring that an API belongs to more than one class. I suggest to use a TAG style classification to mark the API (an API can be tagged with one ore more tags)... the first tags may be the ones just identified

Marco Signorelli (TIM)

tizghadam commented 3 years ago

I guess it will depend on how API classification takes place. We can always try to have categories that are mutually exclusive. For example having classification based on MAPE loop idea (M for Monitoring APIs, A for Analytics APIs, P for plan APIs, E for Execute APIs) makes the API classes almost always mutually exclusive.

I think classification and tagging can co-exist at least at the beginning and we can observe how it evolves (my 2-cents).

Ali Tizghadam (TELUS)

facejuanc commented 3 years ago

We can for sure combine classes and tags, and see how it works. By the way, I miss APIs to allow regular OAM (monitoring, alarms, events, performance...). There is only one for billing/usage. If you think that can make sense we could contribute with a first definition. Juan Carlos (Telefonica)

facejuanc commented 3 years ago

We have added a column ("tags") to the API backlog table and included the tags corresponding to (1) the roles of the ITU-T Cloud Reference Architecture that would make use of that API (user, administrator, business manager), (2) the phases in the customer journey that are covered by the API (TM Forum: Prospect2Order, Order2Activation, Usage2Charging...). Feel free to add tags for classification based on other criteria as you find convenient.

MarkusKuemmerle commented 3 years ago

Added a column in the API list for different tags (CRA, TMF and MAPE)