feat: add check endpoints that do not mirror status code #853
Conversation
internal/check/handler.go
Outdated
| @@ -70,7 +73,7 @@ type getCheckRequest struct { | |||
| MaxDepth int `json:"max-depth"` | |||
| } | |||
|
|
|||
| // swagger:route GET /check read getCheck | |||
| // swagger:route GET /check-sdk read getCheck | |||
There was a problem hiding this comment.
Would it make sense to use a query parameter instead? For example alwaysSend200=true? And I would suggest to keep the response payload the same between the two variants.
Alternatively it could be /check/<method> or /allowed/<method> where <method> could be for example openapi or envoy, traefik, ...
WDYT?
There was a problem hiding this comment.
Alternatively it could be /check/ or /allowed/ where could be for example openapi or envoy, traefik, ...
Makes sense 👍
The problem with query parameter is that no status should be default for SDK, but not default for others.
There was a problem hiding this comment.
Ah, that makes sense yeah. Another option is to use the user-agent, however I think that is not strict enough for security purposes.
There was a problem hiding this comment.
I think you had a good point there 😉 #851 (comment)
hperl
force-pushed
the
fix/sdk-check-errors
branch
from
4ce02ef to
d52c3bb
Compare
zepatrik
force-pushed
the
fix/sdk-check-errors
branch
2 times, most recently
from
70788b5 to
422a8ec
Compare
zepatrik
force-pushed
the
fix/sdk-check-errors
branch
from
422a8ec to
9b89f20
Compare
|
For now we have both check variants as part of the openapi spec. Ideally we would expose both on the docs page, but exclude the status mirroring endpoints from the SDK clients. I am not sure yet where to do that. |
closes #851
Naming should be improved,
/check-sdkis probably not as helpful.