-
Notifications
You must be signed in to change notification settings - Fork 9
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
chore(food,textile,api)!: Remove deprecated API endpoints. #951
Draft
n1k0
wants to merge
27
commits into
master
Choose a base branch
from
chore/deprecate-query-string-based-endpoints
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+1,205
−2,210
Conversation
This file contains 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
2348cd0
to
570c621
Compare
Updated patch, title and description to remove the query-string based endpoints completely because we don't need a deprecation step as we have API versioning to circumvent that. |
9d73804
to
3ae6244
Compare
b3c579f
to
e0aea47
Compare
Switching back to Draft because this depends on #954 to land first. |
vjousse
pushed a commit
that referenced
this pull request
Mar 4, 2025
## 🔧 Problem Query-string based API endpoints have been complicated to maintain over time and don't provide much value over their much simpler POST+JSON equivalent. We should deprecate these redundant GET endpoints. Note: We'll remove them completely in the following major version to clear redundancy and clean a bunch of tech debt along the way (work has been started in #951). ## 🍰 Solution Deprecate these API endpoints which already have a POST+JSON equivalent: - `GET /food` - `GET /textile/simulator` - `GET /textile/simulator/{impact}` - `GET /textile/simulator/detailed` These will be removed in 5.0.0. ## 🏝️ How to test Endpoints should keep working, only the documentation should denote them as deprecated: 
This reverts commit 4cfbad1.
e0aea47
to
e89bcff
Compare
1362e6f
to
85c737c
Compare
2b0e8ea
to
92c26a1
Compare
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.
🔧 Problems
GET
+ query string endpoints completely following deprecation started in 4.0.0 (chore: deprecate textile simulator API GET endpoints. #954).🍰 Solution
GET /food
GET /textile/simulator
GET /textile/simulator/{impact}
GET /textile/simulator/detailed
⏰ Watch out
This patch clears a bunch of tech debt by introducing a dedicated, isolated layer of validation, independent from decoding.
🏝️ How to test