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

add diagram documenting request flow through system #235

Merged
merged 1 commit into from
Apr 26, 2024

Conversation

patrickdemers6
Copy link
Collaborator

Description

Adds a document to explain how the proxy works and how public/private keys are used.

Similar change: teslamotors/fleet-telemetry#166

Type of change

Please select all options that apply to this change:

  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Bug fix (non-breaking change which fixes an issue)
  • Documentation update

Checklist:

Confirm you have completed the following steps:

  • My code follows the style of this project.
  • I have performed a self-review of my code.
  • I have made corresponding updates to the documentation.
  • I have added/updated unit tests to cover my changes.


"Your Backend" -> "Vehicle Commands Proxy": GET /api/1/vehicles/$VIN/command/flash_lights
activate "Vehicle Commands Proxy"
"Vehicle Commands Proxy" -> "Vehicle Commands Proxy": Sign command using private key
Copy link
Collaborator

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?

@sethterashima sethterashima merged commit c66edf1 into teslamotors:main Apr 26, 2024
1 check passed
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.

2 participants