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

Documentation/Clarification on using the new writer API #2285

Closed
quality-leftovers opened this issue Jul 4, 2024 · 4 comments
Closed

Documentation/Clarification on using the new writer API #2285

quality-leftovers opened this issue Jul 4, 2024 · 4 comments
Labels
documentation Issue in the documentation
Milestone

Comments

@quality-leftovers
Copy link
Contributor

The documentation states that the configuration should either happen using configuration or writer endpoint.

However I cannot see any "writer" API to get a list of all writers. Should we still use /v2/configuration for that?

GET /v2/write/ returns method not allowed.

@marcschier marcschier added bug Something isn't working documentation Issue in the documentation labels Jul 4, 2024
@marcschier marcschier added this to the 2.9.10 milestone Jul 4, 2024
@marcschier
Copy link
Collaborator

Are you building/testing main branch? The doc is here.

@marcschier marcschier removed the bug Something isn't working label Jul 4, 2024
@marcschier
Copy link
Collaborator

One more info, the new API should not be used with the old API, or, more concretely, the old API allows creating entries where multiple entries can have the same writer if and group of, but different other settings. The new APIs will then fail with an error that no unique entry to operate on can be identified. Just to be aware.

@quality-leftovers
Copy link
Contributor Author

quality-leftovers commented Jul 10, 2024

Let me clarify my question a bit, I think I didn't do a good job in the initial post :).

Basically I was just wondering whether GET /v2/configuration will be superseded by something else, too or if it's okay to use both

  • GET /v2/configuration (to get an overview, likely with IncludeNodes=true)
  • and the writer API for configuration.

I just want to make sure we don't do something wrong when we switch to the new API.

Cheers

@marcschier
Copy link
Collaborator

No, you can use all GET API calls just fine. And all API calls are supported. The writer API just operates on unique writer entries, and guarantees that, while the other API such as Set configuration or AddOrUpdateNodes can result in entries being created in the config that have the same group/writer id but different configuration, e.g. publishing interval etc. In that case the new API can report an error.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Issue in the documentation
Projects
None yet
Development

No branches or pull requests

2 participants