Open APIs

Hello all

I was looking how to differenciate CFS of RFS in TMF638 v4.0 but the examples does not seem to me compliance with TMF630 REST API Design Guidelines.

I would define a CFS (extract of a CFS), like that :

Definition 1 , Regarding TMF630 & TMF638

(extract with only interesting fields)

{
   "id": "5351",
    "href": "https://mycsp.com:8080/tmf-api/serviceInventory/v4/service/5351",
    "@type": "CustomerFacingService", 
    "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Service/CustomerFacingService.schema.json", 
    "@baseType": "Service"
}

Definition 2 , RegardingTMF638 only

This is an extract from TMF638 v4.0 (extract with only interesting fields)

{
  "id": "5351",
  "href": "https://mycsp.com:8080/tmf-api/serviceInventory/v4/service/5351",
  "serviceType": "Cloud",
  "name": "vCPE serial 1355615",
  "description": "Instantiation of vCPE",
  "category": "CFS"
  "@type": "Service",
  "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Service/vCPE.schema.json"
}

Which definition is correct ?

Why am I struggle ? Because :

What TMF638 Service Inventory v4.0 and TMF630 REST API Design Guildeline said

TMF638:

CFS and RFS are 2 subclasses of Services, therefore regarding TMF630 REST API Design Guidelines Part 2 :

But TMF638 said too :

If you look to TMF633 Service Catalog v4.0, the json definition seems correspond to Definition 1, mixing TMF633 ServiceCatalog specification & TMF 630 API guideline :

Extract of Service Specification example in TMF633 API spec v4.0 :

{
    "id": "7655", 
    "href": "https://mycsp.com:8080/tmf-api/serviceCatalogManagement/v4/serviceSpecification/7655",
    "name": "Firewall Service",
    "@type": "ResourceFacingServiceSpecification",
    "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/ServiceSpecification/ResourceFacingServiceSpecification.schema.json",
    "@baseType": "ServiceSpecification",
}

Regarding to TMF638 v4 Swagger file, a Service haven't @type & @schemaLocation fields.

Regarding to TMF638 v4 PDF specification, theses fields aren't describes for a Service.

So, the example in this PDF wouldn't have theses fields, maybe a little mistake in this document.

So, without theses fields, I guess that the only way to differenciate CFS of RFS is using the Service.category.

This is an extract from TMF638 v4.0 (extract with only interesting fields)

{
  "id": "5351",
  "href": "https://mycsp.com:8080/tmf-api/serviceInventory/v4/service/5351",
  "serviceType": "Cloud",
  "name": "vCPE serial 1355615",
  "description": "Instantiation of vCPE",
  "category": "CFS"
  "@type": "Service",
  "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Service/vCPE.schema.json"
}

Hi Sandrine

You are quite right that the example operation payload in the TMF638 API is misleading.  Sub-classing (CustomerFacingServiceSpecification/ResourceFacingServiceSpecification) in the Service domain Open API is typically only performed for the specs so that you can subclass the service instances in the inventory to add concrete fields to the API, e.g. NetworkService, ShippingService, etc, etc.  The example in the TMF641 API suggest that the serviceType should discriminate between CFS and RFS, whereas in TMF638 the indication is that the category field should be used for this. 

There is another community thread discussion this issue - Discrepancy in TMF641 Service Order category/serviceType fields | TM Forum Community and the corresponding JIRA request is [AP-4592] TMF638 Confusing fields serviceType and category in Service Inventory - TM Forum JIRA

Looking at the discussions in JIRA, it appears that the decision is not to use the category field, suggesting to use the serviceType instead (as per TMF641 examples).  Hopefully this will be corrected in the Open API and PDFs soon.

Sorry this is not much help.

------------------------------
Dan d'Albuquerque
Individual
------------------------------

{  "id": "5351",  "href": "https://mycsp.com:8080/tmf-api/serviceInventory/v4/service/5351",  "serviceType": "Cloud",  "name": "vCPE serial 1355615",  "description": "Instantiation of vCPE",  "category": "CFS"  "@type": "Service",  "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Service/vCPE.schema.json"}