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

Do an API review #297

Open
joeduffy opened this issue Feb 16, 2025 · 0 comments
Open

Do an API review #297

joeduffy opened this issue Feb 16, 2025 · 0 comments
Assignees
Labels
1.0.0-blocker An issue that must be resolved before 1.0.0 kind/design An engineering design doc, usually part of an Epic

Comments

@joeduffy
Copy link
Member

As part of getting to 1.0 for this repo, we should do an all up API review of the types and methods.

I found some of them awkward to use, such as calls like Create accepting a name string rather than the full resource URN as the provider RPC accepts. I am all for presenting a simple interface, however, I don't believe we should be lossy in doing so.

This is not the sole reason to do an API review -- we want to ensure we are happy with the interfaces overall here since we will be recommending folks use them to author providers, and won't want to break them down the road -- but this is a significant class of issue.

@joeduffy joeduffy added 1.0.0-blocker An issue that must be resolved before 1.0.0 kind/design An engineering design doc, usually part of an Epic needs-triage Needs attention from the triage team labels Feb 16, 2025
@rquitales rquitales removed the needs-triage Needs attention from the triage team label Feb 19, 2025
@rquitales rquitales self-assigned this Feb 19, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
1.0.0-blocker An issue that must be resolved before 1.0.0 kind/design An engineering design doc, usually part of an Epic
Projects
None yet
Development

No branches or pull requests

2 participants