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

The wording in the Mandatory template for info.description is unclear #178

Open
RandyLevensalor opened this issue Jun 28, 2024 · 2 comments · May be fixed by #214
Open

The wording in the Mandatory template for info.description is unclear #178

RandyLevensalor opened this issue Jun 28, 2024 · 2 comments · May be fixed by #214
Labels
correction API specification needs correction documentation Improvements or additions to documentation ICM-Backlog spring25-candidate

Comments

@RandyLevensalor
Copy link

Problem description

The wording in the Mandatory template for info.description is unclear.

Which specific authorization flows are to be used will be determined during onboarding process, happening between the API Client and the Telco Operator exposing the API, taking into account the declared purpose for accessing the API, while also being subject to the prevailing legal framework dictated by local legislation.

Expected behavior
At a minimum add a the before onboarding process or use the plural onboarding processes if that was the intent.

- during onboarding process
+ during the onboarding process

Alternative solution

Alternately, split this into two sentences.

"The specific authorization flows to be used will be determined during the onboarding process between the API client and the Telco operator exposing the API. This determination will consider the declared purpose for accessing the API and be subject to the prevailing legal framework dictated by local legislation."

Additional context

We've added this Mandatory text to QoD and it isn't clear.

I'm happy to create a PR and discuss further.

@AxelNennker
Copy link
Collaborator

During the ICM meeting on 17. July we decided to change info.description after the release

@RandyLevensalor
Copy link
Author

Thanks @AxelNennker it would be difficult to roll out at this stage in the release.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
correction API specification needs correction documentation Improvements or additions to documentation ICM-Backlog spring25-candidate
Projects
None yet
3 participants