-
Notifications
You must be signed in to change notification settings - Fork 9
Description
Problem description
Camara API Design Guidelines advise API designers to avoid telco specific terminology in API definitions.
https://github.com/camaraproject/Commonalities/blob/main/documentation/API-design-guidelines.md#25-reduce-telco-specific-terminology-in-api-definitions
code/API_definitions/CAMARA Mobile Device Identifier API.yaml contains this sentence.
The Mobile Device Identifier API returns details of the mobile device (also know as the UE, or User Equipment) currently being used by a specified mobile subscriber.
Apart from a grammar issue, that sentence does not provide information to the API consumer.
Expected action
Reduce telco specific terms by removing the word in parentheses.
The Mobile Device Identifier API returns details of the mobile device currently being used by a specified mobile subscriber.
Additional context