Parameter names used in the API spec need to be revisited to make them more developer friendly

[maheshc01]

As we have discussed during the calls, there is need to take a closer look at the parameter names used in the API spec with the objective of making the parameter names more developer friendly such that they can be understood by just going over the spec and would not require them to reference a separate document.

Example: "asId" can be renamed to "applicationServerEndpoint"

This needs to be looked at high priority as changing the parameter names after initial release will impact backward compatibility.

[hdamker]

Fully agree that this has to be addressed before the first release. Just the addition that some of the parameter names are relevant across several APIs (e.g. a better name for "UeID") and should be defined in context of the API Design Guidelines in the Commonalities Working Group.

[GarethWGSMA]

In a similar vein, can I ask if we've stipulated in commonalities whether the uri's should be formatted using spinal case, camel case or pascal case etc? I'm wondering as we're producing a suite of 8 API's, that the developers would appreciate consistency - thus it needs setting in the commonalities and not leaving it to the individual working groups.

[RandyLevensalor]

Is there any interest in updating these names to be more inclusive of wireline broadband service?

For instance replacing mobile specific terms like UE with something more inclusive. Such as device, user_devices, cpe, or target_device.

[GarethWGSMA]

Hi,

I thought there was guidance in Camara commonalities (or at least should be), about API formatting.

Gareth

From: Randy Levensalor @.> Sent: 08 December 2022 15:15 To: camaraproject/QualityOnDemand @.> Cc: Gareth Williams @.>; Comment @.> Subject: Re: [camaraproject/QualityOnDemand] Parameter names used in the API spec need to be revisited to make them more developer friendly (Issue #44)

"This email has been received from an external source - please review before actioning, clicking on links, or opening attachments"

Is there any interest in updating these names to be more inclusive of wireline broadband service?

For instance replacing mobile specific terms like UE with something more inclusive. Such as device, user_devices, cpe, or target_device.

- Reply to this email directly, view it on GitHubhttps://eur03.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fcamaraproject%2FQualityOnDemand%2Fissues%2F44%23issuecomment-1342886089&data=05%7C01%7Cgwilliams%40gsma.com%7C95617879b69248410d0d08dad92f0bc8%7C72a4ff82fec3469daafbac8276216699%7C0%7C0%7C638061093328296551%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=qGZM2Itu3KtiC977KJWOTO35V1qbVOIP%2BnMcw%2FYLIUc%3D&reserved=0, or unsubscribehttps://eur03.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fnotifications%2Funsubscribe-auth%2FA2I7LGE32UQKRZQIKR7PAYTWMH3RDANCNFSM6AAAAAAQUJPFL4&data=05%7C01%7Cgwilliams%40gsma.com%7C95617879b69248410d0d08dad92f0bc8%7C72a4ff82fec3469daafbac8276216699%7C0%7C0%7C638061093328296551%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=kj3c7LHmyrp1fmL3Cvt0ceFUvdoNzYOEFVA5TVEop4E%3D&reserved=0. You are receiving this because you commented.Message ID: @.**@.>>

.

[RandyLevensalor]

Hi, I thought there was guidance in Camara commonalities (or at least should be), about API formatting. Gareth

Good point. I've opened an issue for this with commonalities as well. https://github.com/camaraproject/WorkingGroups/issues/108

[hdamker]

Superseded by #90 as requested by Commonalities.