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

[Docs] COM-RPC tags #1367

Merged
merged 4 commits into from
Jul 31, 2023
Merged

[Docs] COM-RPC tags #1367

merged 4 commits into from
Jul 31, 2023

Conversation

TeknoVenus
Copy link
Contributor

Move the tags documentation from ThunderTools repo into main documentation portal

Update to include latest tags

@github-actions
Copy link

github-actions bot commented Jul 19, 2023

PR Preview Action v1.1.1-25-g59e77e4
🛬 Preview removed because the pull request was closed.
2023-07-31 15:37 UTC

docs/plugin/interfaces/tags.md Outdated Show resolved Hide resolved
docs/plugin/interfaces/tags.md Outdated Show resolved Hide resolved
docs/plugin/interfaces/tags.md Outdated Show resolved Hide resolved
docs/plugin/interfaces/tags.md Show resolved Hide resolved
@TeknoVenus
Copy link
Contributor Author

@sebaszm Made some minor tweaks to address comments.

If you could clarify the difference between the collapsed/extended compliant tags that would be appreciated.

@sebaszm
Copy link
Contributor

sebaszm commented Jul 31, 2023

@sebaszm Made some minor tweaks to address comments.

If you could clarify the difference between the collapsed/extended compliant tags that would be appreciated.

Thanks!

The snag is in the way how calls with a single parameter are defined. The JSON-RPC compliant way is to enclose them in an object, like params: { "name": "abcd" }. Historically there was also possible to collapse it, like params: "abcd", since there is only one parameter it doesn't need a name to be accessed. So the collapsed format means that methods, notifications and properties omit the enclosing object when there is only one parameter to pass. The exteneded format is a mixture where the collapse is only used for properties, since they enforce one parameter anyway, but not for methods and notifications. And compliant format is that all calls including properties use the enclosing object. Collapsed and extended are not recommended for new interfaces.

@sebaszm sebaszm self-requested a review July 31, 2023 09:31
@pwielders pwielders merged commit 9b2bbd6 into rdkcentral:master Jul 31, 2023
8 of 12 checks passed
bramoosterhuis pushed a commit to bramoosterhuis/Thunder that referenced this pull request Apr 26, 2024
* [Docs] COM-RPC tags

* Address review comments

* Improve compliant/uncompliant documentation

---------

Co-authored-by: Pierre Wielders <pierre@wielders.net>
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