Rename properties to new terms #129

jlurien · 2023-03-09T11:02:07Z

Applied lowerCamelCase for property names, UpperCamelCase for schema names
Updated API_documentation as well. This is a redundant effort that hopefully we don't have to maintain in the future, as being discussed in Revisit API documentation template to reduce redundancy WorkingGroups#164
In a separate PR we should enhance descriptions, once Glossary definitions are consolidated.

- Applied lowerCamelCase for property names, UpperCamelCase for schema names - Updated API_documentation as well. This is a redundant effort that hopefully we don't have to maintain in the future, as being discussed in camaraproject/WorkingGroups#164 - In a separate PR we should enhance descriptions, once Glossary definitions are consolidated.

hdamker · 2023-03-09T19:37:28Z

We should wait with this PR until camaraproject/WorkingGroups#157 is finally decided with a vote as requested by Telefonica.

hdamker · 2023-03-24T11:29:02Z

Guess we are ready to due these changes now as the guidelines are also updated.

@eric-murray @jlurien @patrice-conil @sfnuser @akoshunyadi would you have a look and approve as well?

sfnuser · 2023-03-24T13:10:15Z

code/API_definitions/qod-api.yaml

@@ -63,41 +63,41 @@ paths:
                    code: INVALID_ARGUMENT
                    message: "Schema validation failed at  ..."
                MsisdnRequired:


Should we update this line too?

I would say so.

Done in ed3bbdc

akoshunyadi · 2023-03-27T11:08:12Z

documentation/API_documentation/QoD_API.md

@@ -26,14 +26,14 @@ Security access keys such as OAuth 2.0 client credentials used by client applica
 **QoS profiles and QoS profile labels**
 Latency or throughput requirements of the application mapped to relevant QoS profile class.

-**Identifier for the the user equipment (UE)**
-At least one identifier for the user equipment out of four options: IPv4 address, IPv6 address, MSISDN, or external ID [[5]](#5) assigned by the mobile network operator for the user equipment
+**Identifier for the the device**


typo: the the

Done in fe2cef9

akoshunyadi · 2023-03-27T11:10:14Z

documentation/API_documentation/QoD_API.md

-**Identifier for the the user equipment (UE)**
-At least one identifier for the user equipment out of four options: IPv4 address, IPv6 address, MSISDN, or external ID [[5]](#5) assigned by the mobile network operator for the user equipment
+**Identifier for the the device**
+At least one identifier for the device (user equipment) out of four options: IPv4 address, IPv6 address, Phone number, or Network Access Identifier [[5]](#5) assigned by the mobile network operator for the device.

 **Identifier for the application server (AS)**


AS is not used anymore, more occurrences are affected

Done in fe2cef9 (plus replaced one remaining occurence of UE).

hdamker · 2023-04-05T18:59:24Z

@jlurien will you resolve the comments or should I?

MsisdnRequired replaced with PhoneNumber required.

Corrected type and remaining occurences of AS and UE.

hdamker · 2023-04-13T05:52:50Z

AS @jlurien seems not be available I have addressed the comments above.
@akoshunyadi and @sfnuser can you shortly check and approve?

sfnuser · 2023-04-13T11:50:10Z

AS @jlurien seems not be available I have addressed the comments above. @akoshunyadi and @sfnuser can you shortly check and approve?

@hdamker - Cheers. Are we planning to update the commit in two other places (line 83 & 95) as well?

Further updates of error examples in lines 71, 77, 83, 89, 95

hdamker · 2023-04-13T12:04:13Z

@sfnuser :

Are we planning to update the commit in two other places (line 83 & 95) as well?

Thanks for the hint ... have done further updates of error examples in lines 71, 77, 83, 89, 95 to get all the error examples consistent with the new property terms. Please have a view.

sfnuser · 2023-04-13T12:42:26Z

@sfnuser :

Are we planning to update the commit in two other places (line 83 & 95) as well?

Thanks for the hint ... have done further updates of error examples in lines 71, 77, 83, 89, 95 to get all the error examples consistent with the new property terms. Please have a view.

Thanks. Looks good to me.

sfnuser · 2023-03-24T13:10:55Z

code/API_definitions/qod-api.yaml

                  value:
                    status: 400
                    code: INVALID_ARGUMENT
-                    message: "Expected property is missing: qos"
+                    message: "Expected property is missing: qosProfile"
                UePortsRangesNotAllowed:


same as above

@hdamker - are we planning to update this one too?

sfnuser · 2023-03-24T13:18:26Z

code/API_definitions/qod-api.yaml

                  value:
                    status: 400
                    code: INVALID_ARGUMENT
-                    message: "Expected property is missing: ueId.ipv4addr or ueId.ipv6addr"
+                    message: "Expected property is missing: device.ipv4Address or device.ipv6Address"
                UePortsRequired:


same as above

@hdamker - are we planning to update this one too?

hdamker

Hopefully we have now found all occurence which need to be replaced.

jlurien requested review from hdamker and shilpa-padgaonkar as code owners March 9, 2023 11:02

hdamker previously approved these changes Mar 24, 2023

View reviewed changes

hdamker requested review from akoshunyadi, eric-murray, patrice-conil and sfnuser March 24, 2023 11:28

sfnuser reviewed Mar 24, 2023

View reviewed changes

akoshunyadi reviewed Mar 27, 2023

View reviewed changes

Update qod-api.yaml

ed3bbdc

MsisdnRequired replaced with PhoneNumber required.

hdamker dismissed their stale review via ed3bbdc April 13, 2023 05:42

Update QoD_API.md

fe2cef9

Corrected type and remaining occurences of AS and UE.

Update qod-api.yaml

614c9d2

Further updates of error examples in lines 71, 77, 83, 89, 95

sfnuser approved these changes Apr 13, 2023

View reviewed changes

hdamker approved these changes Apr 13, 2023

View reviewed changes

akoshunyadi approved these changes Apr 14, 2023

View reviewed changes

hdamker merged commit 6d72b46 into camaraproject:main Apr 14, 2023

This was referenced Apr 14, 2023

Resolving ueAddr ambiguity when it is the UE private address #34

Closed

Adds service provider defined QoS profiles #125

Closed

Alignment with API design guidelines #97

Closed

hdamker mentioned this pull request Jun 17, 2023

Pre release v0.9.0 rc #169

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Rename properties to new terms #129

Rename properties to new terms #129

jlurien commented Mar 9, 2023

hdamker commented Mar 9, 2023

hdamker commented Mar 24, 2023

sfnuser Mar 24, 2023

hdamker Apr 5, 2023

hdamker Apr 13, 2023

akoshunyadi Mar 27, 2023

hdamker Apr 13, 2023

akoshunyadi Mar 27, 2023

hdamker Apr 13, 2023

hdamker commented Apr 5, 2023 •

edited

Loading

hdamker commented Apr 13, 2023

sfnuser commented Apr 13, 2023

hdamker commented Apr 13, 2023

sfnuser commented Apr 13, 2023

sfnuser Mar 24, 2023

sfnuser Apr 13, 2023

sfnuser Mar 24, 2023

sfnuser Apr 13, 2023

hdamker left a comment

Rename properties to new terms #129

Rename properties to new terms #129

Conversation

jlurien commented Mar 9, 2023

hdamker commented Mar 9, 2023

hdamker commented Mar 24, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hdamker commented Apr 5, 2023 • edited Loading

hdamker commented Apr 13, 2023

sfnuser commented Apr 13, 2023

hdamker commented Apr 13, 2023

sfnuser commented Apr 13, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hdamker left a comment

Choose a reason for hiding this comment

hdamker commented Apr 5, 2023 •

edited

Loading