Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update commonalities glossary with subproject relevant terms #15

Closed
shilpa-padgaonkar opened this issue Jan 16, 2023 · 4 comments
Closed

Comments

@shilpa-padgaonkar
Copy link
Collaborator

camaraproject/WorkingGroups#120

@NoelWirzius
Copy link
Collaborator

NoelWirzius commented Jan 31, 2023

Version 0.1.0 properties

Proposed alternatives follow the guideline in commonalities to name properties in snake_case.

Terms shared with other APIs

Current term Proposed alternatives Comment
ueId device_info, device, user_device, device_id It should be added in description that it refers to client or user device, if not included in the name property. If it is an object with several details instead of a single unique ID, as it is now, maybe _id is not very accurate.
msisdn phone_number, mobile_number MSISDN is really restricted to mobile phone numbers, but phone number is more generic. While MSISDN is very common in Telco industry it may not be friendly to general devs
ipv4Addr ip_v4_address At some moment we may think in consolidating both V4 and V6 formats in one single property ip_address as version can be deducted from value
ipv6Addr ip_v6_address  
externalId external_id Description should be enhanced to inform about this option. Pending on discussions in commonalities around adoption of 3GPP GPSI
uePort device_port, client_port uePort used for device identification in NAT scenarios should be consolidated within device info object

Check Device specific terms

Current term Proposed alternatives Comment
eventType event_type no changes

I would like to have some internal feedback prior to take these terms to the global glossary.

@rartych
Copy link
Collaborator

rartych commented Mar 3, 2023

In order to integrate the common glossary in Commonalities it is needed to provide the first version of subproject relevant terms by 15th of March.

@rartych
Copy link
Collaborator

rartych commented Mar 29, 2023

I propose to wait for results of Commonalities PR:
camaraproject/WorkingGroups#120

With the latest Guidelines change regarding camelCase we got the following list:

Version 0.2.0 properties

Proposed alternatives follow the guideline in commonalities to name properties in camelCase.

Terms shared with other APIs

Current term Proposed alternatives Comment
ueId deviceInfo, device, userDevice, deviceId It should be added in description that it refers to client or user device, if not included in the name property. If it is an object with several details instead of a single unique ID, as it is now, maybe _id is not very accurate.
msisdn phoneNumber, mobileNumber MSISDN is really restricted to mobile phone numbers, but phone number is more generic. While MSISDN is very common in Telco industry it may not be friendly to general devs
ipv4Addr ipv4Address At some moment we may think in consolidating both V4 and V6 formats in one single property ipAddress as version can be deducted from value
ipv6Addr ipv6Address like above
externalId externalId no change: Description should be enhanced to inform about this option. Pending on discussions in commonalities around adoption of 3GPP GPSI
uePort devicePort, clientPort uePort used for device identification in NAT scenarios should be consolidated within device info object

Check Device specific terms

Current term Proposed alternatives Comment
eventType eventType no change: term used in event subscription/notification in other APIs too

@shilpa-padgaonkar
Copy link
Collaborator Author

Thank you very much for the contribution to commonalities glossary.
https://github.com/camaraproject/WorkingGroups/blob/main/Commonalities/documentation/Glossary.md

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants