diff --git a/obp-api/src/main/scala/code/api/util/ApiTag.scala b/obp-api/src/main/scala/code/api/util/ApiTag.scala index 27ae8c1dff..58b153bf88 100644 --- a/obp-api/src/main/scala/code/api/util/ApiTag.scala +++ b/obp-api/src/main/scala/code/api/util/ApiTag.scala @@ -72,6 +72,7 @@ object ApiTag { val apiTagMethodRouting = ResourceDocTag("Method-Routing") val apiTagWebUiProps = ResourceDocTag("WebUi-Props") val apiTagEndpointMapping = ResourceDocTag("Endpoint-Mapping") + val apiTagRateLimits = ResourceDocTag("Rate-Limits") val apiTagApiCollection = ResourceDocTag("Api-Collection") diff --git a/obp-api/src/main/scala/code/api/v3_1_0/APIMethods310.scala b/obp-api/src/main/scala/code/api/v3_1_0/APIMethods310.scala index 3ba00314f9..2c11009fd7 100644 --- a/obp-api/src/main/scala/code/api/v3_1_0/APIMethods310.scala +++ b/obp-api/src/main/scala/code/api/v3_1_0/APIMethods310.scala @@ -513,9 +513,11 @@ trait APIMethods310 { nameOf(callsLimit), "PUT", "/management/consumers/CONSUMER_ID/consumer/call-limits", - "Set Calls Limit for a Consumer", + "Set Rate Limiting (call limits) per Consumer", s""" - |Set the API call limits for a Consumer: + |Set the API rate limiting (call limits) per Consumer: + | + |Call limits can be set: | |Per Second |Per Minute @@ -1221,6 +1223,9 @@ trait APIMethods310 { |Is rate limiting enabled and active? |What backend is used to keep track of the API calls (e.g. REDIS). | + |Note: Rate limiting can be set at the Consumer level and also for anonymous calls. + | + |See the consumer rate limits / call limits endpoints. | |${authenticationRequiredMessage(true)} | @@ -1228,7 +1233,7 @@ trait APIMethods310 { EmptyBody, rateLimitingInfoV310, List(UnknownError), - List(apiTagApi)) + List(apiTagApi, apiTagRateLimits)) lazy val getRateLimitingInfo: OBPEndpoint = { diff --git a/obp-api/src/main/scala/code/api/v4_0_0/APIMethods400.scala b/obp-api/src/main/scala/code/api/v4_0_0/APIMethods400.scala index 0ea0bd02ae..6f1e3691d7 100644 --- a/obp-api/src/main/scala/code/api/v4_0_0/APIMethods400.scala +++ b/obp-api/src/main/scala/code/api/v4_0_0/APIMethods400.scala @@ -191,9 +191,11 @@ trait APIMethods400 { nameOf(callsLimit), "PUT", "/management/consumers/CONSUMER_ID/consumer/call-limits", - "Set Calls Limit for a Consumer", + "Set Rate Limits / Call Limits per Consumer", s""" - |Set the API call limits for a Consumer: + |Set the API rate limits / call limits for a Consumer: + | + |Rate limiting can be set: | |Per Second |Per Minute @@ -216,7 +218,7 @@ trait APIMethods400 { UpdateConsumerError, UnknownError ), - List(apiTagConsumer), + List(apiTagConsumer, apiTagRateLimits), Some(List(canSetCallLimits))) lazy val callsLimit : OBPEndpoint = {