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

Feature/cert extn sdk #271

Open
wants to merge 14 commits into
base: next
Choose a base branch
from
Open

Feature/cert extn sdk #271

wants to merge 14 commits into from

Conversation

kevinshahfws
Copy link
Contributor

No description provided.

Copy link

Core SDK - MFOS standalone sanity report:
Passes - 197 Failures - 0 Pending - 0 Skipped - 5
Report JSON/HTML Files: https://github.com/rdkcentral/firebolt-apis/suites/24074005029/artifacts/1528492431
Job Logs: https://github.com/rdkcentral/firebolt-apis/actions/runs/9197527153

Copy link
Contributor

Choose a reason for hiding this comment

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

typo with onFireboltInterections (onFireboltInteractions)

}
],
"result": {
"name": "success",
Copy link
Contributor

Choose a reason for hiding this comment

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

no need for success fields in results

}
],
"result": {
"name": "success",
Copy link
Contributor

Choose a reason for hiding this comment

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

no need for success fields in result

"name": "Screen capture and sends back the image stream with base64 encoded",
"params": [],
"result": {
"name": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mP8/wcAAgMBApDPF90AAAAASUVORK5CYII=",
Copy link
Contributor

Choose a reason for hiding this comment

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

Think we need to consider returning the image asynchronously as chunks

"result": {
"name": "event",
"value": {
"interactionRequest": {
Copy link
Contributor

Choose a reason for hiding this comment

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

probably could just have this be a json string instead individual fields being in the schema here.

"params": [
{
"name": "uploadPath",
"value": "http://example.com/upload"

Choose a reason for hiding this comment

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

How would the upload actually work? Wouldn't this functionality require additional details, such as HTTP auth headers, etc?

},
{
"name": "healthCheck",
"summary": "",

Choose a reason for hiding this comment

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

This one needs a summary

},
{
"name": "appPerformance",
"summary": "",

Choose a reason for hiding this comment

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

Same as above; needs a summary

"name": "appPerformanceResult",
"summary": "Result of the interaction",
"schema": {
"$ref": "#/components/schemas/AppPerformanceSnapshotResult"

Choose a reason for hiding this comment

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

Wondering if we should align healthCheck and appPerformance methods, as they seem to be related and return similar values.

Maybe systemHealthCheck and appHealthCheck?

"type": "number",
"description": "The cpu usage of the system"
},
"deviceMemory": {
Copy link

@alkalinecoffee alkalinecoffee Jun 10, 2024

Choose a reason for hiding this comment

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

What do you think about using other adjectives on these values? It's reasonable that we might want to expand this object to return more fields later on, so it might be helpful to be clear in our responses now e.g.

cpuLoad1minAverage
cpuLoad5minAverage
deviceMemoryUsed
memoryUsed
memoryLimit

We also might want to note the units in the field descriptions, particularly on the memory values. I assume they're in Mb?

Copy link

Core SDK - MFOS standalone sanity report:
Passes - 198 Failures - 0 Pending - 0 Skipped - 8
Report JSON/HTML Files: https://github.com/rdkcentral/firebolt-apis/suites/25138527226/artifacts/1622172720
Job Logs: https://github.com/rdkcentral/firebolt-apis/actions/runs/9603017007

Copy link

Core SDK - MFOS standalone sanity report:
Passes - 198 Failures - 0 Pending - 0 Skipped - 8
Report JSON/HTML Files: https://github.com/rdkcentral/firebolt-apis/suites/25356437803/artifacts/1642120929
Job Logs: https://github.com/rdkcentral/firebolt-apis/actions/runs/9686430219

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants