Skip to content

Commit 1819465

Browse files
tricky42ory-bot
authored andcommitted
feat: add ratelimit buckets to swagger definitions
GitOrigin-RevId: 854dea8de34fc0402fbe1641af7f076f977cbcbc
1 parent b1d203f commit 1819465

File tree

8 files changed

+376
-94
lines changed

8 files changed

+376
-94
lines changed

client/handler.go

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,9 @@ type createOAuth2Client struct {
8888
// 201: oAuth2Client
8989
// 400: errorOAuth2BadRequest
9090
// default: errorOAuth2Default
91+
//
92+
// Extensions:
93+
// x-ory-ratelimit-bucket: hydra-admin-high
9194
func (h *Handler) createOAuth2Client(w http.ResponseWriter, r *http.Request) {
9295
c, err := h.CreateClient(r, h.r.ClientValidator().Validate, false)
9396
if err != nil {
@@ -139,6 +142,9 @@ type createOidcDynamicClient struct {
139142
// 201: oAuth2Client
140143
// 400: errorOAuth2BadRequest
141144
// default: errorOAuth2Default
145+
//
146+
// Extensions:
147+
// x-ory-ratelimit-bucket: hydra-public-high
142148
func (h *Handler) createOidcDynamicClient(w http.ResponseWriter, r *http.Request) {
143149
if err := h.requireDynamicAuth(r); err != nil {
144150
h.r.Writer().WriteError(w, r, err)
@@ -246,6 +252,9 @@ type setOAuth2Client struct {
246252
// 400: errorOAuth2BadRequest
247253
// 404: errorOAuth2NotFound
248254
// default: errorOAuth2Default
255+
//
256+
// Extensions:
257+
// x-ory-ratelimit-bucket: hydra-admin-high
249258
func (h *Handler) setOAuth2Client(w http.ResponseWriter, r *http.Request) {
250259
var c Client
251260
if err := json.NewDecoder(r.Body).Decode(&c); err != nil {
@@ -334,6 +343,9 @@ type setOidcDynamicClient struct {
334343
// 200: oAuth2Client
335344
// 404: errorOAuth2NotFound
336345
// default: errorOAuth2Default
346+
//
347+
// Extensions:
348+
// x-ory-ratelimit-bucket: hydra-public-high
337349
func (h *Handler) setOidcDynamicClient(w http.ResponseWriter, r *http.Request) {
338350
if err := h.requireDynamicAuth(r); err != nil {
339351
h.r.Writer().WriteError(w, r, err)
@@ -417,6 +429,9 @@ type patchOAuth2Client struct {
417429
// 200: oAuth2Client
418430
// 404: errorOAuth2NotFound
419431
// default: errorOAuth2Default
432+
//
433+
// Extensions:
434+
// x-ory-ratelimit-bucket: hydra-admin-high
420435
func (h *Handler) patchOAuth2Client(w http.ResponseWriter, r *http.Request) {
421436
patchJSON, err := io.ReadAll(r.Body)
422437
if err != nil {
@@ -506,6 +521,9 @@ type listOAuth2ClientsParameters struct {
506521
// Responses:
507522
// 200: listOAuth2Clients
508523
// default: errorOAuth2Default
524+
//
525+
// Extensions:
526+
// x-ory-ratelimit-bucket: hydra-admin-medium
509527
func (h *Handler) listOAuth2Clients(w http.ResponseWriter, r *http.Request) {
510528
pageKeys := h.r.Config().GetPaginationEncryptionKeys(r.Context())
511529
pagination, err := keysetpagination.ParseQueryParams(pageKeys, r.URL.Query())
@@ -570,6 +588,9 @@ type adminGetOAuth2Client struct {
570588
// Responses:
571589
// 200: oAuth2Client
572590
// default: errorOAuth2Default
591+
//
592+
// Extensions:
593+
// x-ory-ratelimit-bucket: hydra-admin-low
573594
func (h *Handler) Get(w http.ResponseWriter, r *http.Request) {
574595
id := r.PathValue("id")
575596
c, err := h.r.ClientManager().GetConcreteClient(r.Context(), id)
@@ -621,6 +642,9 @@ type getOidcDynamicClient struct {
621642
// Responses:
622643
// 200: oAuth2Client
623644
// default: errorOAuth2Default
645+
//
646+
// Extensions:
647+
// x-ory-ratelimit-bucket: hydra-admin-low
624648
func (h *Handler) getOidcDynamicClient(w http.ResponseWriter, r *http.Request) {
625649
if err := h.requireDynamicAuth(r); err != nil {
626650
h.r.Writer().WriteError(w, r, err)
@@ -680,6 +704,9 @@ type deleteOAuth2Client struct {
680704
// Responses:
681705
// 204: emptyResponse
682706
// default: genericError
707+
//
708+
// Extensions:
709+
// x-ory-ratelimit-bucket: hydra-admin-high
683710
func (h *Handler) deleteOAuth2Client(w http.ResponseWriter, r *http.Request) {
684711
id := r.PathValue("id")
685712
if err := h.r.ClientManager().DeleteClient(r.Context(), id); err != nil {
@@ -720,6 +747,9 @@ type setOAuth2ClientLifespans struct {
720747
// Responses:
721748
// 200: oAuth2Client
722749
// default: genericError
750+
//
751+
// Extensions:
752+
// x-ory-ratelimit-bucket: hydra-admin-high
723753
func (h *Handler) setOAuth2ClientLifespans(w http.ResponseWriter, r *http.Request) {
724754
id := r.PathValue("id")
725755
c, err := h.r.ClientManager().GetConcreteClient(r.Context(), id)
@@ -783,6 +813,9 @@ type dynamicClientRegistrationDeleteOAuth2Client struct {
783813
// Responses:
784814
// 204: emptyResponse
785815
// default: genericError
816+
//
817+
// Extensions:
818+
// x-ory-ratelimit-bucket: hydra-public-high
786819
func (h *Handler) deleteOidcDynamicClient(w http.ResponseWriter, r *http.Request) {
787820
if err := h.requireDynamicAuth(r); err != nil {
788821
h.r.Writer().WriteError(w, r, err)

consent/handler.go

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,9 @@ type _ struct {
112112
// Responses:
113113
// 204: emptyResponse
114114
// default: errorOAuth2
115+
//
116+
// Extensions:
117+
// x-ory-ratelimit-bucket: hydra-admin-high
115118
func (h *Handler) revokeOAuth2ConsentSessions(w http.ResponseWriter, r *http.Request) {
116119
var (
117120
subject = r.URL.Query().Get("subject")
@@ -188,6 +191,9 @@ type _ struct {
188191
// Responses:
189192
// 200: oAuth2ConsentSessions
190193
// default: errorOAuth2
194+
//
195+
// Extensions:
196+
// x-ory-ratelimit-bucket: hydra-admin-low
191197
func (h *Handler) listOAuth2ConsentSessions(w http.ResponseWriter, r *http.Request) {
192198
subject := r.URL.Query().Get("subject")
193199
if subject == "" {
@@ -272,6 +278,9 @@ type _ struct {
272278
// Responses:
273279
// 204: emptyResponse
274280
// default: errorOAuth2
281+
//
282+
// Extensions:
283+
// x-ory-ratelimit-bucket: hydra-admin-high
275284
func (h *Handler) revokeOAuth2LoginSessions(w http.ResponseWriter, r *http.Request) {
276285
sid := r.URL.Query().Get("sid")
277286
subject := r.URL.Query().Get("subject")
@@ -336,6 +345,9 @@ type _ struct {
336345
// 200: oAuth2LoginRequest
337346
// 410: oAuth2RedirectTo
338347
// default: errorOAuth2
348+
//
349+
// Extensions:
350+
// x-ory-ratelimit-bucket: hydra-admin-low
339351
func (h *Handler) getOAuth2LoginRequest(w http.ResponseWriter, r *http.Request) {
340352
var err error
341353
ctx, span := h.r.Tracer(r.Context()).Tracer().Start(r.Context(), "consent.getOAuth2LoginRequest")
@@ -412,6 +424,9 @@ type _ struct {
412424
// Responses:
413425
// 200: oAuth2RedirectTo
414426
// default: errorOAuth2
427+
//
428+
// Extensions:
429+
// x-ory-ratelimit-bucket: hydra-admin-low
415430
func (h *Handler) acceptOAuth2LoginRequest(w http.ResponseWriter, r *http.Request) {
416431
var err error
417432
ctx, span := h.r.Tracer(r.Context()).Tracer().Start(r.Context(), "consent.acceptOAuth2LoginRequest")
@@ -528,6 +543,9 @@ type _ struct {
528543
// Responses:
529544
// 200: oAuth2RedirectTo
530545
// default: errorOAuth2
546+
//
547+
// Extensions:
548+
// x-ory-ratelimit-bucket: hydra-admin-low
531549
func (h *Handler) rejectOAuth2LoginRequest(w http.ResponseWriter, r *http.Request) {
532550
var err error
533551
ctx, span := h.r.Tracer(r.Context()).Tracer().Start(r.Context(), "consent.rejectOAuth2LoginRequest")
@@ -619,6 +637,9 @@ type _ struct {
619637
// 200: oAuth2ConsentRequest
620638
// 410: oAuth2RedirectTo
621639
// default: errorOAuth2
640+
//
641+
// Extensions:
642+
// x-ory-ratelimit-bucket: hydra-admin-low
622643
func (h *Handler) getOAuth2ConsentRequest(w http.ResponseWriter, r *http.Request) {
623644
var err error
624645
ctx, span := h.r.Tracer(r.Context()).Tracer().Start(r.Context(), "consent.getOAuth2ConsentRequest")
@@ -698,6 +719,9 @@ type _ struct {
698719
// Responses:
699720
// 200: oAuth2RedirectTo
700721
// default: errorOAuth2
722+
//
723+
// Extensions:
724+
// x-ory-ratelimit-bucket: hydra-admin-low
701725
func (h *Handler) acceptOAuth2ConsentRequest(w http.ResponseWriter, r *http.Request) {
702726
var err error
703727
ctx, span := h.r.Tracer(r.Context()).Tracer().Start(r.Context(), "consent.acceptOAuth2ConsentRequest")
@@ -792,6 +816,9 @@ type _ struct {
792816
// Responses:
793817
// 200: oAuth2RedirectTo
794818
// default: errorOAuth2
819+
//
820+
// Extensions:
821+
// x-ory-ratelimit-bucket: hydra-admin-low
795822
func (h *Handler) rejectOAuth2ConsentRequest(w http.ResponseWriter, r *http.Request) {
796823
ctx := r.Context()
797824

@@ -869,6 +896,9 @@ type _ struct {
869896
// Responses:
870897
// 200: oAuth2RedirectTo
871898
// default: errorOAuth2
899+
//
900+
// Extensions:
901+
// x-ory-ratelimit-bucket: hydra-admin-low
872902
func (h *Handler) acceptOAuth2LogoutRequest(w http.ResponseWriter, r *http.Request) {
873903
challenge := cmp.Or(
874904
r.URL.Query().Get("logout_challenge"),
@@ -912,6 +942,9 @@ type _ struct {
912942
// Responses:
913943
// 204: emptyResponse
914944
// default: errorOAuth2
945+
//
946+
// Extensions:
947+
// x-ory-ratelimit-bucket: hydra-admin-low
915948
func (h *Handler) rejectOAuth2LogoutRequest(w http.ResponseWriter, r *http.Request) {
916949
challenge := cmp.Or(
917950
r.URL.Query().Get("logout_challenge"),
@@ -950,6 +983,9 @@ type _ struct {
950983
// 200: oAuth2LogoutRequest
951984
// 410: oAuth2RedirectTo
952985
// default: errorOAuth2
986+
//
987+
// Extensions:
988+
// x-ory-ratelimit-bucket: hydra-admin-low
953989
func (h *Handler) getOAuth2LogoutRequest(w http.ResponseWriter, r *http.Request) {
954990
challenge := cmp.Or(
955991
r.URL.Query().Get("logout_challenge"),
@@ -1006,6 +1042,9 @@ type _ struct {
10061042
// Responses:
10071043
// 200: oAuth2RedirectTo
10081044
// default: errorOAuth2
1045+
//
1046+
// Extensions:
1047+
// x-ory-ratelimit-bucket: hydra-admin-low
10091048
func (h *Handler) acceptUserCodeRequest(w http.ResponseWriter, r *http.Request) {
10101049
ctx := r.Context()
10111050

0 commit comments

Comments
 (0)