Add initial implementation of API #320
Open
Conversation
This file contains hidden or 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
…ntation This commit introduces a versioned API structure for ToolHive that follows Go best practices for API design. The API provides a clean separation between the public interface and the internal implementation, allowing each to evolve independently. Key changes: - Create versioned API package structure (pkg/api/v1) - Define comprehensive API types with interfaces - Implement conversion functions between API and internal types - Fix all linting issues in the implementation The API is organized into: 1. Types (pkg/api/v1/types.go) - Data structures used in the API 2. Interfaces (pkg/api/v1/api.go) - API contract definitions 3. Conversion (pkg/api/v1/convert/*) - Type conversion functions This design provides several benefits: - API stability through versioning - Implementation freedom through separation - Clear boundaries between client and server - Self-documenting through Go doc comments The actual implementation of the API functionality will be added in subsequent commits. Signed-off-by: Juan Antonio Osorio <[email protected]>
Signed-off-by: Juan Antonio Osorio <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This adds an initial implementation of an API for ToolHive, it implements a "local"
client that simply runs everything in-process. Most subcommands of
thvare now usingthis except for
thv runwhich is more complex and merits dedicated work.The intention is to take the local server and wrap it with an HTTP implementation so
we could have a REST API. Maybe in the future we'll also have a gRPC implementation.
Related-to: #310