teslatte/tesla_api_coverage
2023-10-25 15:49:57 +11:00
..
cached wip(tesla_api_coverage): scrape vehicle command 2023-10-23 14:25:33 +11:00
src docs: README and API updates about APIs 2023-10-25 15:49:57 +11:00
.gitignore wip(tesla_api_coverage): scrape vehicle command 2023-10-23 14:25:33 +11:00
Cargo.toml wip(tesla_api_coverage): broken, but wip parse teslatte endpoints 2023-10-24 12:30:48 +11:00
README.md wip(tesla_api_coverage): more massaging of endpoints 2023-10-25 12:24:36 +11:00

API Coverage

A tool designed to compare the API calls between teslatte and the publicly documented Tesla APIs.

Note: This tool is bespoke to the build of teslatte and is not intended for publishing on crates.io.

This project does (or will do) the following:

API.md output

  • Update API.md in the root.
  • Look for <!-- tesla_api_coverage start table --> and <!-- tesla_api_coverage end table --> and generate the table in between.
  • Use timdorr's API as the source of truth for the list of endpoints because it is the oldest and longest!

Brainstorm

Combined format idea:

{
  "honk_horn": {
    
    // If owner-api vs fleet-api methods are different, they should have different entries,
    // otherwise call it "rest":
    "rest": {
      "method": "POST",
      "endpoint": "/vehicles/{vehicle_id}/command/honk_horn"
    },
    "vehicle-command": {
      "endpoint": "honk"
    }
    
    "timdorr-endpoints-file": true,
    "teslatte": true,
    "owners-api": true,
    "fleet-api": true,
  }
}