fix(api): use query param instead of body for GET /backend/monitor#9273
Open
Bahtya wants to merge 1 commit intomudler:masterfrom
Open
fix(api): use query param instead of body for GET /backend/monitor#9273Bahtya wants to merge 1 commit intomudler:masterfrom
Bahtya wants to merge 1 commit intomudler:masterfrom
Conversation
The /backend/monitor endpoint uses HTTP GET but its Swagger annotation declares a request body, which violates REST conventions and breaks OpenAPI code generators and Swagger UI. Echo's c.Bind() already handles query parameters for GET requests, so only the Swagger annotation needs to be fixed. Fixes mudler#9207 Signed-off-by: bahtya <bahtyar153@qq.com>
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
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.
Problem
The
/backend/monitorendpoint uses HTTP GET but its Swagger annotation declares a request body (@Param request body schema.BackendMonitorRequest). This violates REST conventions and breaks:Root Cause
The Swagger annotation in
backend_monitor.gouses@Param request bodyfor a GET endpoint. Per OpenAPI spec, GET requests should not have request bodies.Solution
Changed the Swagger annotation from body param to query param:
Echo's
c.Bind()already handles query parameters for GET requests, so no code changes are needed — only the annotation fix.Testing
Fixes #9207