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

Addition of "lastStatusTime" Field #146

Merged

Conversation

sachinvodafone
Copy link
Collaborator

@sachinvodafone sachinvodafone commented Apr 26, 2024

What type of PR is this?
Add one of the following kinds:

correction

What this PR does / why we need it:
The CAMARA version of the current DeviceStatus API lacks a crucial "lastStatusTime" field, resulting in inconsistent behavior across vendors. This absence poses challenges for application developers in determining the freshness of roaming status/connectivity data.

Which issue(s) this PR fixes:
Fixes #110

@sachinvodafone
Copy link
Collaborator Author

Could someone help me to validate the Linter errors that coming up ?

@fernandopradocabrillo
Copy link
Collaborator

fernandopradocabrillo commented Apr 26, 2024

In the log appear a list of linting errors:

/github/workspace/code/API_definitions/device-status.yaml
    452:12  warning  camara-properties-descriptions  Property description is missing or empty: "openId.description" property must be truthy                                                                 components.securitySchemes.openId
    475:27  warning  camara-properties-descriptions  Property description is missing or empty: "RoamingStatusResponse.description" property must be truthy                                                  components.schemas.RoamingStatusResponse
    499:32  warning  camara-properties-descriptions  Property description is missing or empty: "ConnectivityStatusResponse.description" property must be truthy                                             components.schemas.ConnectivityStatusResponse
    557:20     hint  camara-discriminator-use        Ensure that API definition YAML files with oneOf or anyOf sections include a discriminator object for serialization, deserialization, and validation.  components.schemas.DeviceIpv4Addr
    610:26  warning  camara-properties-descriptions  Property description is missing or empty: "RequestRoamingStatus.description" property must be truthy                                                   components.schemas.RequestRoamingStatus
    618:31  warning  camara-properties-descriptions  Property description is missing or empty: "RequestConnectivityStatus.description" property must be truthy                                              components.schemas.RequestConnectivityStatus
    626:15  warning  camara-properties-descriptions  Property description is missing or empty: "ErrorInfo.description" property must be truthy                                                              components.schemas.ErrorInfo
    784:16    error  oas3-valid-schema-example       "example" property must match format "uuid"                                                                                                            components.schemas.SubscriptionId.example
    857:24  warning  oas3-unused-component           Potentially unused component has been detected.                                                                                                        components.schemas.EventRoamingStatus
    866:20  warning  oas3-unused-component           Potentially unused component has been detected.                                                                                                        components.schemas.EventRoamingOn
    875:21  warning  oas3-unused-component           Potentially unused component has been detected.                                                                                                        components.schemas.EventRoamingOff
    884:31  warning  oas3-unused-component           Potentially unused component has been detected.                                                                                                        components.schemas.EventRoamingChangeCountry
    893:27  warning  oas3-unused-component           Potentially unused component has been detected.                                                                                                        components.schemas.EventConnectivityData
    902:26  warning  oas3-unused-component           Potentially unused component has been detected.                                                                                                        components.schemas.EventConnectivitySms
    911:35  warning  oas3-unused-component           Potentially unused component has been detected.                                                                                                        components.schemas.EventConnectivityDisconnected
    920:27  warning  oas3-unused-component           Potentially unused component has been detected.                                                                                                        components.schemas.EventSubscriptionEnds
   1091:20  warning  camara-properties-descriptions  Property description is missing or empty: "ROAMING_STATUS.description" property must be truthy                                                         components.examples.ROAMING_STATUS
   1[107](https://github.com/camaraproject/DeviceStatus/actions/runs/8847659758/job/24295924753?pr=146#step:6:114):17  warning  camara-properties-descriptions  Property description is missing or empty: "ROAMING_OFF.description" property must be truthy                                                            components.examples.ROAMING_OFF
   1120:16  warning  camara-properties-descriptions  Property description is missing or empty: "ROAMING_ON.description" property must be truthy                                                             components.examples.ROAMING_ON
   1133:28  warning  camara-properties-descriptions  Property description is missing or empty: "ROAMING_CHANGE_COUNTRY.description" property must be truthy                                                 components.examples.ROAMING_CHANGE_COUNTRY
   1148:23  warning  camara-properties-descriptions  Property description is missing or empty: "CONNECTIVITY_DATA.description" property must be truthy                                                      components.examples.CONNECTIVITY_DATA
   1161:22  warning  camara-properties-descriptions  Property description is missing or empty: "CONNECTIVITY_SMS.description" property must be truthy                                                       components.examples.CONNECTIVITY_SMS
   1174:31  warning  camara-properties-descriptions  Property description is missing or empty: "CONNECTIVITY_DISCONNECTED.description" property must be truthy                                              components.examples.CONNECTIVITY_DISCONNECTED
   1187:23  warning  camara-properties-descriptions  Property description is missing or empty: "SUBSCRIPTION_ENDS.description" property must be truthy                                                      components.examples.SUBSCRIPTION_ENDS

It seems, we have included a wrong example set for 'UUID', so I have corrected the same. Thanks for looking into this

@bigludo7
Copy link
Collaborator

Could someone help me to validate the Linter errors that coming up ?

The error was on the uuid ?
I saw a lot of warning but only one error

Anyway seems you solved it ;)

bigludo7
bigludo7 previously approved these changes Apr 26, 2024
Copy link
Collaborator

@bigludo7 bigludo7 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/LGTM

code/API_definitions/device-status.yaml Outdated Show resolved Hide resolved
code/API_definitions/device-status.yaml Outdated Show resolved Hide resolved
Copy link
Collaborator

@bigludo7 bigludo7 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@fernandopradocabrillo
Copy link
Collaborator

@akoshunyadi @sachinvodafone
LGTM

It's okey from our side, we can proceed to merge. Thanks!

@akoshunyadi akoshunyadi merged commit 5ae875e into camaraproject:main May 8, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
v0.6.0 Planned for release v0.6.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Request for Addition of "last_updated_timestamp" Field in CAMARA DeviceStatus API
4 participants