-
Notifications
You must be signed in to change notification settings - Fork 101
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
add diagram documenting request flow through system #235
Merged
sethterashima
merged 1 commit into
teslamotors:main
from
patrickdemers6:system-flow-diagram
Apr 26, 2024
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
@startuml | ||
title Authorization Flow | ||
"developer.tesla.com" -> "Your Backend": Store Client ID and Client Secret securely | ||
|
||
== Obtain a Partner Authentication Token == | ||
"Your Backend" -> "Tesla Auth": POST https://auth.tesla.com/oauth2/v3/token | ||
"Your Backend" <-- "Tesla Auth": {"access_token": "jwt"} | ||
|
||
== Obtain a Third-Party Token == | ||
"User" -> "Tesla Auth": https://auth.tesla.com/oauth2/v3/authorize | ||
"User" <-- "Tesla Auth": Redirect URL | ||
"User" -> "Your Backend": Redirect URL sends token to your backend | ||
"Your Backend" -> "Tesla Auth": Code Exchange\nPOST https://auth.tesla.com/oauth2/v3/token | ||
"Your Backend" <-- "Tesla Auth": {"access_token": "jwt"} | ||
|
||
@enduml |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
@startuml | ||
title Vehicle Commands Proxy | ||
|
||
"Your Backend" -> "Vehicle Commands Proxy": GET /api/1/vehicles/$VIN/command/flash_lights\n(includes Bearer token) | ||
activate "Vehicle Commands Proxy" | ||
"Vehicle Commands Proxy" -> "Vehicle Commands Proxy": Sign command using private key | ||
|
||
"Vehicle Commands Proxy" -> "Fleet API": Signed command | ||
activate "Fleet API" | ||
|
||
"Fleet API" -> Vehicle: Signed command | ||
activate Vehicle | ||
Vehicle -> Vehicle: Validate signature\nusing public key | ||
Vehicle -> Vehicle: Flash Lights | ||
Vehicle --> "Fleet API": Response | ||
deactivate Vehicle | ||
|
||
"Fleet API" --> "Vehicle Commands Proxy": Response | ||
deactivate "Fleet API" | ||
|
||
"Vehicle Commands Proxy" --> "Your Backend": Response | ||
deactivate "Vehicle Commands Proxy" | ||
@enduml |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Would the diagram become too crowded if we included also showed the OAuth token being sent from the backend to the proxy and from the proxy to Fleet API?