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

Reduce telco specific terms #69

Closed
AxelNennker opened this issue Aug 5, 2024 · 0 comments · Fixed by #77
Closed

Reduce telco specific terms #69

AxelNennker opened this issue Aug 5, 2024 · 0 comments · Fixed by #77
Labels
documentation Improvements or additions to documentation

Comments

@AxelNennker
Copy link
Collaborator

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

@AxelNennker AxelNennker added the documentation Improvements or additions to documentation label Aug 5, 2024
@Kevsy Kevsy closed this as completed in #77 Aug 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant