Open APIs

Hi community,

Could you help undestand the usageType? (tmf654 v4) it is defined several times as:
A string. defines the type of the underlying Balance e.g. data,voice, any currency e.g. EUR, USD etc.

But the swagger defines it as an Enum, and appendix (page 134) seems to suggest it should be restricted to values in the table. Should it be a String or a Enum?

Also there seems to be contradiction, as definition examples EUR, USD but the tables says usageType: "monetary", and units (In quantity) EUR, USD. The later matches the examples.

Should usageType values be restricted to Enum values?

From swagger:

        "UsageType": {            "type": "string",            "description": "Valid values for the usage type are",            "enum": [                "monetary",                "voice",                "data",                "sms",                "other"            ]        },

------------------------------
Jesus Marval
Liberty Latin America
------------------------------

Hi
I'm sorry that I can't give you an authoritative answer. My (educated) guess is that the API designers did not want to commit to a strongly-typed list of usage types, since these would generally be defined in a usage or product catalog. But they did want to be able to show a typical list of values as part of the API assets (and not just as part of a field description). So they defined the enum, so that it could be generated into documents and diagrams, but they didn't use the enum as a datatype.
Hope it helps.
@Elisabeth Andersson perhaps you want to add something here?

------------------------------
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: Apr 17, 2023 18:01
From: Jesus Marval
Subject: usageType in tmf654

Hi community,

Could you help undestand the usageType? (tmf654 v4) it is defined several times as:
A string. defines the type of the underlying Balance e.g. data,voice, any currency e.g. EUR, USD etc.

But the swagger defines it as an Enum, and appendix (page 134) seems to suggest it should be restricted to values in the table. Should it be a String or a Enum?

Also there seems to be contradiction, as definition examples EUR, USD but the tables says usageType: "monetary", and units (In quantity) EUR, USD. The later matches the examples.

Should usageType values be restricted to Enum values?

From swagger:

        "UsageType": {            "type": "string",            "description": "Valid values for the usage type are",            "enum": [                "monetary",                "voice",                "data",                "sms",                "other"            ]        },

------------------------------
Jesus Marval
Liberty Latin America
------------------------------

Hi,

If you look in the Early Adoption section of the API Tablee you'll find there's an updated Swagger for this API. The updates address the issues you mention. usageType is no longer defined as an enum. This also clears up the monetary vs currency point.

Hope this helps

Phil

Hi
I'm sorry that I can't give you an authoritative answer. My (educated) guess is that the API designers did not want to commit to a strongly-typed list of usage types, since these would generally be defined in a usage or product catalog. But they did want to be able to show a typical list of values as part of the API assets (and not just as part of a field description). So they defined the enum, so that it could be generated into documents and diagrams, but they didn't use the enum as a datatype.
Hope it helps.
@Elisabeth Andersson perhaps you want to add something here?

------------------------------
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: Apr 17, 2023 18:01
From: Jesus Marval
Subject: usageType in tmf654

Hi community,

Could you help undestand the usageType? (tmf654 v4) it is defined several times as:
A string. defines the type of the underlying Balance e.g. data,voice, any currency e.g. EUR, USD etc.

But the swagger defines it as an Enum, and appendix (page 134) seems to suggest it should be restricted to values in the table. Should it be a String or a Enum?

Also there seems to be contradiction, as definition examples EUR, USD but the tables says usageType: "monetary", and units (In quantity) EUR, USD. The later matches the examples.

Should usageType values be restricted to Enum values?

From swagger:

        "UsageType": {            "type": "string",            "description": "Valid values for the usage type are",            "enum": [                "monetary",                "voice",                "data",                "sms",                "other"            ]        },

------------------------------
Jesus Marval
Liberty Latin America
------------------------------