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

[meta] Provide a new API #30

Closed
Annopaolo opened this issue Jan 17, 2023 · 2 comments
Closed

[meta] Provide a new API #30

Annopaolo opened this issue Jan 17, 2023 · 2 comments
Assignees
Labels
enhancement New feature or request

Comments

@Annopaolo
Copy link
Collaborator

Annopaolo commented Jan 17, 2023

The current API is quirky and difficult to integrate as a dependency, especially for AppEngine-related functions.
Provide a new, polished and idiomatic API.

The following packages will be exported:

  • interfaces: interface parsing and validation,
  • device-utils: Astarte device ID generation and handling (e.g. conversion to/from UUID),
  • auth: all things related to Astarte auth (via JWT),
  • client: HTTP client for Astarte services aimed at interacting with the Astarte APIs and parsing retrieved data.
  • data: parsing functions for data retrieved using the client package.

This is a major change, and possibly breaking. As such, parts of the current codebase will be rewritten: as the Go modules reference suggest, a v0 version does not signal stability or backward compatibility guarantees.
The old API will be supported for now (see the release-0.90 branch), and deprecated in the future.
A migration path to the new API should be provided, along with documantation on new guidelines and good practices.

This is a meta issue to keep track of all changes required.

@Annopaolo Annopaolo added the enhancement New feature or request label Jan 17, 2023
@Annopaolo Annopaolo changed the title [meta] Provide a new v1 API [meta] Provide a new API Jan 18, 2023
@matt-mazzucato
Copy link
Collaborator

The original message has been updated, i.e. the data package is not needed anymore (see #34).

@Annopaolo
Copy link
Collaborator Author

All items have been completed.

Annopaolo added a commit to Annopaolo/astartectl that referenced this issue Feb 27, 2023
Use the new astarte-go API.
See astarte-platform/astarte-go#30.

Signed-off-by: Arnaldo Cesco <arnaldo.cesco@secomind.com>
Annopaolo added a commit to Annopaolo/astartectl that referenced this issue Mar 7, 2023
Use the new astarte-go API.
See astarte-platform/astarte-go#30.

Signed-off-by: Arnaldo Cesco <arnaldo.cesco@secomind.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants