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.

Sign up for GitHub

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

Update uDiscovery specs #118

Closed
wants to merge 12 commits into from
Closed

Update uDiscovery specs #118

Show file tree
Hide file tree
Changes from 11 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
f065ef7
Updates to discovery proto and readme
maykarandikar Apr 18, 2024
2e89ef2
Add sequence diagram for FindUE
maykarandikar Apr 18, 2024
04e5bf9
Updated readme file for discovery
maykarandikar Apr 18, 2024
57d8a5a
Resolve initial comments
maykarandikar Apr 18, 2024
8e4796f
Added description for all APIs
maykarandikar Apr 23, 2024
8fce52a
Update up-core-api/uprotocol/core/udiscovery/v3/udiscovery.proto
mayureshkar Apr 23, 2024
d44cef8
Addressed review comments
maykarandikar Apr 23, 2024
b87f01d
proto file update
maykarandikar Apr 23, 2024
cfe50ed
Updated proto and readme files
maykarandikar Apr 24, 2024
bc314d9
Added set ue properties API
maykarandikar Apr 25, 2024
437f9ae
added registration APIs
maykarandikar Apr 25, 2024
c44f923
corrected few things in proto
maykarandikar May 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
465 changes: 217 additions & 248 deletions up-core-api/uprotocol/core/udiscovery/v3/udiscovery.proto
View file
Open in desktop

Large diffs are not rendered by default.

61 changes: 42 additions & 19 deletions up-l3/udiscovery/v3/lookup_uri.puml → up-l3/udiscovery/v3/FindUE.puml
View file
Open in desktop
Copy link
Contributor

Choose a reason for hiding this comment

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

Personally, I think it would be simpler to just state that lookups traverse from local to domain to centeral in lieu of the complicated diagrams to simplify the specs.

Original file line number Diff line number Diff line change
Expand Up @@ -29,63 +29,86 @@ autonumber

box uDevice #white
Collections uEs #red
entity LDS #orange
entity uLDS #orange
entity uDDS #orange
entity uCDS #orange
end box
entity CDS #orange

uEs -> LDS: LookupUri(UriRequest)
uEs -> uLDS: FinduE(FinduERequest)
note right
<size:14>**UriRequest:**</size>
<size:14>**FinduERequest:**</size>
""uri"": ""//topic//""
end note

alt Found Locally
LDS --> uEs: UriResponse
uLDS --> uEs: FinduEResponse
note right
<size:14>**UriRequest:**</size>
<size:14>**FinduEResponse:**</size>
""uris"": {""//topic//"", ""//topic//""}
""result"": {""code"": ""OK""}
end note
|||
else Invalid Argument or Permission Denied
LDS --> uEs: UriResponse
uLDS --> uEs: FinduEResponse
note right
<size:14>**UriResponse:**</size>
<size:14>**FinduEResponse:**</size>
""result"" : { ""code"": ""INVALID_ARGUMENT | PERMISSION_DENIED"" }
end note
|||
else Remote Lookup Required
LDS -> CDS: LookupUri(UriRequest)
uLDS -> uDDS: FinduE(FinduERequest)
alt Success
CDS --> LDS: UriResponse
uDDS --> uLDS: FinduEResponse
note right
<size:14>**UriResponse:**</size>
<size:14>**FinduEResponse:**</size>
""uris"": {""//topic//"", ""//topic//""}
""result"": {""code"": ""OK""}
end note
LDS -> LDS: Cache (per ttl)
LDS --> uEs: UriResponse
uLDS -> uLDS: Cache (per ttl)
uLDS --> uEs: FinduEResponse
note right
<size:14>**UriResponse:**</size>
<size:14>**FinduEResponse:**</size>
""uris"": {""//topic//"", ""//topic//""}
""result"": {""code"": ""OK""}
end note
|||
else Remote Lookup Required
uDDS -> uCDS: FinduE(FinduERequest)
alt Success
uCDS --> uDDS: FinduEResponse
note right
<size:14>**FinduEResponse:**</size>
""uris"": {""//topic//"", ""//topic//""}
""result"": {""code"": ""OK""}
end note
uDDS -> uDDS: Cache (per ttl)
uDDS --> uLDS: FinduEResponse
uLDS -> uLDS : Cache( per ttl)
uLDS --> uEs : FinduEResponse
note right
<size:14>**FinduEResponse:**</size>
""uris"": {""//topic//"", ""//topic//""}
""result"": {""code"": ""OK""}
end note
|||
else Failure
CDS --> LDS: UriResponse
uDDS --> uLDS: FinduEResponse
note right
<size:14>**UriResponse:**</size>
<size:14>**FinduEResponse:**</size>
""result"": {""code"": ""INVALID_ARGUMENT | NOT_FOUND | PERMISSION_DENIED""}
end note
LDS --> uEs: UriResponse
uLDS --> uEs: FinduEResponse
end alt

else Not Found
LDS --> uEs: UriResponse
uLDS --> uEs: FinduEResponse
note right
<size:14>**UriResponse:**</size>
<size:14>**FinduEResponse:**</size>
""result"": {""code"": ""NOT_FOUND""}
end note
end alt

LDS --> uEs: UriResponse
uLDS --> uEs: FinduEResponse
end alt
@enduml
1 change: 1 addition & 0 deletions up-l3/udiscovery/v3/FindUE.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading