RLP-148854: Add established Rate Limits to API Endpoint descriptions.…

… Included Categories: Collections Microservice, Account Groups, Resource Lists (#738)
PaloAltoNetworks · Sep 9, 2024 · aa02fc3 · aa02fc3
1 parent 53db4e0
commit aa02fc3
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 9 deletions.
diff --git a/openapi-specs/cspm/AccountGroups.json b/openapi-specs/cspm/AccountGroups.json
@@ -241,7 +241,7 @@
   "paths": {
     "/cloud/group": {
       "get": {
-        "description": "Returns an array of accessible account groups.",
+        "description": "Returns an array of accessible account groups.\n\n#### Rate Limits ####\n* Request rate limit: 32/sec \n* Burst Rate: 32/sec \n",
         "operationId": "get-account-groups",
         "parameters": [
           {
@@ -324,7 +324,7 @@
     },
     "/cloud/group/name": {
       "get": {
-        "description": "Returns list of account group IDs, names, and whether or not the group was created automatically.",
+        "description": "Returns list of account group IDs, names, and whether or not the group was created automatically.\n\n#### Rate Limits ####\n* Request rate limit: 32/sec \n* Burst Rate: 32/sec \n",
         "operationId": "get-account-group-name",
         "parameters": [
           {
@@ -365,7 +365,7 @@
     },
     "/cloud/group/name/{cloud_type}": {
       "get": {
-        "description": "Returns list of account group IDs and names filtered by cloud type.",
+        "description": "Returns list of account group IDs and names filtered by cloud type.\n\n#### Rate Limits ####\n* Request rate limit: 4/sec \n* Burst Rate: 4/sec \n",
         "operationId": "get-account-group-name-by-cloudType",
         "parameters": [
           {
@@ -416,7 +416,7 @@
     },
     "/cloud/group/{id}": {
       "get": {
-        "description": "Retrieve all information about an account group using its ID.",
+        "description": "Retrieve all information about an account group using its ID.\n\n#### Rate Limits ####\n* Request rate limit: 80/sec \n* Burst Rate: 80/sec \n",
         "operationId": "get-account-group",
         "parameters": [
           {

diff --git a/openapi-specs/cspm/CollectionsMicroservice.json b/openapi-specs/cspm/CollectionsMicroservice.json
@@ -72,7 +72,7 @@
           "Collections"
         ],
         "summary": "Get Collection by ID",
-        "description": "Returns all details of a Collection.\n:::info\nThis endpoint is available on the Prisma Cloud Darwin release only.\n:::\n",
+        "description": "Returns all details of a Collection.\n:::info\nThis endpoint is available on the Prisma Cloud Darwin release only.\n:::\n\n#### Rate Limits ####\n* Request rate limit: 8/sec \n* Burst Rate: 8/sec \n ",
         "externalDocs": {
           "url": "entitlement/api/v1/collection/#id",
           "x-ga": "false"
@@ -326,7 +326,7 @@
           "Collections"
         ],
         "summary": "Get All Collections",
-        "description": "Returns all Collections in a paginated format, sorted by ID desc.\n:::info\nThis endpoint is available on the Prisma Cloud Darwin release only.\n:::\n",
+        "description": "Returns all Collections in a paginated format, sorted by ID desc.\n:::info\nThis endpoint is available on the Prisma Cloud Darwin release only.\n:::\n\n#### Rate Limits ####\n* Request rate limit: 4/sec \n* Burst Rate: 4/sec \n",
         "externalDocs": {
           "url": "entitlement/api/v1/collection",
           "x-ga": "false"

diff --git a/openapi-specs/cspm/ResourceLists.json b/openapi-specs/cspm/ResourceLists.json
@@ -71,7 +71,7 @@
   "paths": {
     "/v1/resource_list": {
       "get": {
-        "description": "Returns all the resource lists for the current customer.",
+        "description": "Returns all the resource lists for the current customer.\n\n#### Rate Limits \nThe following rate limits apply:\n* Request rate limit: 80/sec \n* Burst Rate: 80/sec\n",
         "operationId": "get-all-resource-list-for-customer",
         "parameters": [
           {
@@ -163,7 +163,7 @@
     },
     "/v1/resource_list/types": {
       "get": {
-        "description": "Returns a list of resource list types.",
+        "description": "Returns a list of resource list types.\n\n#### Rate Limits \nThe following rate limits apply:\n* Request rate limit: 4/sec \n* Burst Rate: 4/sec\n",
         "operationId": "get-resource-list-types",
         "responses": {
           "200": {
@@ -193,7 +193,7 @@
     },
     "/v1/resource_list/{id}": {
       "get": {
-        "description": "Returns the resource list that has the specified ID.",
+        "description": "Returns the resource list that has the specified ID.\n\n#### Rate Limits \nThe following rate limits apply:\n* Request rate limit: 4/sec \n* Burst Rate: 4/sec\n",
         "operationId": "get-resource-list-by-id",
         "parameters": [
           {