Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Revise SDL-0153 Support for Short and Full UUID App ID #578

Conversation

Jack-Byrne
Copy link
Contributor

@Jack-Byrne Jack-Byrne commented Aug 6, 2018

Introduction

This is a revision to make fullAppID mandatory="false" and to add a clarifying note regarding appID case insensitivity.

Motivation

Make Full App ID Non Mandatory

There is language in the original proposal conflicting with the fullAppID RPC spec definition.

From proposal:

If only the (short) appID is present in the RegisterAppInterface RPC request (legacy apps), sdl core shall use the (short) appID as the internal policy app id. i.e. use appID as the policy_app_id and use it to construct the icon path.

In order for this case to be possible, fullAppID must be non mandatory. In addition, even with mobile version negotiation, making fullAppID mandatory would cause a breaking change in RegisterAppInterfaceRequest for legacy applications.

Include Note Regarding AppID Case Insensitivity

During the Core implementation of this original proposal, it was discovered that there was an existing behavior in Core that converts incoming appIDs from a RegisterAppInterfaceRequest to lowercase. I am adding this note to the proposal for documentation and visibility purposes.

Proposed solution

Change fullAppID rpc spec signature to:

Value Type Mandatory Description
fullAppID String False ID used to validate app with policy table entries

Potential downsides

None the author could identify.

Impact on existing code

Change mandatory value fullAppID in mobile_api.xml in RPC Spec to false.

Alternatives considered

No alternatives were considered.

@Jack-Byrne Jack-Byrne changed the title Update fullAppID to mandatory=false. Include note about lowercase. Revise 0153-support-short-long-appid Aug 6, 2018
@Jack-Byrne Jack-Byrne changed the title Revise 0153-support-short-long-appid Revise 0153 Support for Short and Full UUID App ID Aug 6, 2018
@Jack-Byrne Jack-Byrne changed the title Revise 0153 Support for Short and Full UUID App ID Revise SDL-0153 Support for Short and Full UUID App ID Aug 6, 2018
@Jack-Byrne
Copy link
Contributor Author

@theresalech Ready for review

Copy link
Contributor

@theresalech theresalech left a comment

Choose a reason for hiding this comment

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

@JackLivio can you please update the description to include the proper proposal formatting (introduction, motivation, etc.)? Here's an example for reference: #572. Let me know of any questions, thanks!

# for free to join this conversation on GitHub. Already have an account? # to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants