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

Request for local HTTP API V3. Make local HTTP API more conform to the best practices. #202

Open
ai91 opened this issue Mar 17, 2024 · 2 comments

Comments

@ai91
Copy link

ai91 commented Mar 17, 2024

It's a great product, with rich features. Unfortunately some aspects don't really follow best practice.
For example see #201.
Another issue is usage GET requests for all non-idempotent requests and non-safe requests.

Suggestion: make all write-methods as POST/PUT requests.
More info: https://nordicapis.com/understanding-idempotency-and-safety-in-api-design/

@0xFEEDC0DE64
Copy link
Contributor

also wouldnt we break existing installations for all customers? breaking all existing software that is able to talk to our products, the only way I could see this change is by providing an on/off toggle for this new safety measures which is off by default

@ai91
Copy link
Author

ai91 commented Apr 2, 2024

also wouldnt we break existing installations for all customers? breaking all existing software that is able to talk to our products, the only way I could see this change is by providing an on/off toggle for this new safety measures which is off by default

Sure, it will break, and sure it must be off by default. Therefore I wrote "V3", keeping in mind an idea that for backwards compatibility there shall be V2 as a default with an option to switch to V3.
Though not sure how much memory do you have for additional code, if it even possible to support so many features you already have.

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

No branches or pull requests

2 participants