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

Initial SDK Review #1

Merged
merged 23 commits into from
Sep 11, 2024
Merged

Initial SDK Review #1

merged 23 commits into from
Sep 11, 2024

Conversation

Asfiroth
Copy link
Member

No description provided.

@Asfiroth Asfiroth marked this pull request as ready for review August 20, 2024 17:31
README.md Outdated
Please visit the DIMO [Developer Documentation](https://docs.Dimo.zone/developer-platform) to learn more about building on DIMO and detailed information on the API.

### Developer License
Copy link
Member

Choose a reason for hiding this comment

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

Let's update this to something similar to the NodeJS one with DevConsole https://github.com/DIMO-Network/dimo-node-sdk?tab=readme-ov-file#developer-registration

README.md Outdated
.AddRestServices()
.AddGraphQLServices()
.AddStreamr()
Copy link
Member

Choose a reason for hiding this comment

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

Do we want to include this now?

README.md Outdated
#### Prerequisites for Authentication

1. A valid Developer License.
Copy link
Member

Choose a reason for hiding this comment

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

@jamesliupenn
Copy link
Member

Assigning this over to @JamesReate for C# code reviews.

@Asfiroth
Copy link
Member Author

I've updated the PR according to the comments @jamesliupenn @JamesReate

___

#### Device Data API
Copy link
Member

Choose a reason for hiding this comment

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

Should this be the Telemetry GraphQL instead now?

Copy link
Member Author

Choose a reason for hiding this comment

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

I think I will need to change to another example like on node sdk: https://github.com/DIMO-Network/dimo-node-sdk?tab=readme-ov-file#querying-the-dimo-rest-api

README.md Show resolved Hide resolved
Copy link
Member

@JamesReate JamesReate left a comment

Choose a reason for hiding this comment

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

I think this is a good first take on this. But I'm sure we'll need to take another pass at it as real developers start playing with it.

Thoughts:
I am unsure of including API wrappers for all the endpoints in devices-api, eg. smartcar or tesla specific things. Same for vehicle signal decoding. Device definitions api also in theory external developers wouldn't need since all that stuff should be available via identity-api.
Adding some comments in some of the services files may also be good - if these are auto-generated from swagger maybe could auto bring in the comments from swagger.

@Asfiroth Asfiroth merged commit fb460a9 into master Sep 11, 2024
@Asfiroth Asfiroth deleted the develop branch September 11, 2024 22:21
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.

3 participants