Merge pull request #34 from mariano-martin1/mariano/add-quotas-note

Add quotas information

Author: MaximeGoyette

docs/api-reference/v2/endpoints/search/get-search.mdx

@@ -2,3 +2,7 @@
 title: "Search"
 openapi: firework-v2-openapi get /search/
 ---
+
+import GlobalSearchApiQuotaNote from '/snippets/global-search-api-quota-note.mdx';
+
+<GlobalSearchApiQuotaNote />

docs/api-reference/v2/endpoints/search/post-search.mdx

@@ -1,4 +1,8 @@
 ---
 openapi: firework-v2-openapi post /search/
 title: Search
----
+---
+
+import GlobalSearchApiQuotaNote from '/snippets/global-search-api-quota-note.mdx';
+
+<GlobalSearchApiQuotaNote />

docs/api-reference/v4/endpoints/global-search.mdx

@@ -4,5 +4,7 @@ api: "POST https://api.flare.io/firework/v4/events/global/_search"
 ---
 
 import EventSearchCommon from '/snippets/endpoint-event-search-common.mdx';
+import GlobalSearchApiQuotaNote from '/snippets/global-search-api-quota-note.mdx';
 
+<GlobalSearchApiQuotaNote />
 <EventSearchCommon />

docs/concepts/rate-limits.mdx docs/concepts/rate-limits-and-quotas.mdxdocs/concepts/rate-limits.mdx renamed to docs/concepts/rate-limits-and-quotas.mdx

@@ -1,7 +1,8 @@
 ---
-title: 'Rate Limits'
+title: 'Rate Limits and Quotas'
 ---
 
+## Rate Limits
 
 API usage exceeding 1 request per second is subject to Flare's API rate limit.
 Rate Limits are enforced **per organization**.
@@ -22,3 +23,11 @@ If you receive 429 errors, Flare's recommended course of action is to wait 10 se
 ```
 
 </ResponseExample>
+
+
+## Quotas
+API users are responsible for monitoring their Global Search API usage and ensuring it remains within their allocated monthly quota.
+  
+Each response includes `X-Flare-Global-Searches-Remaining`: The number of API calls remaining in your monthly allocation.
+
+To avoid service interruptions or missed events, we recommend implementing proactive monitoring of your usage.

docs/introduction/getting-started.mdx

@@ -12,7 +12,7 @@ The Flare API can be used to access Flare's search capabilities, configure monit
     Create an API Key and obtain API tokens.
   </Card>
 
-  <Card title="Rate Limits" icon="gauge-high" href="/concepts/rate-limits">
+  <Card title="Rate Limits" icon="gauge-high" href="/concepts/rate-limits-and-quotas">
     Learn about the Flare API's rate limits.
   </Card>
 

docs/mint.json

@@ -91,7 +91,7 @@
       "group": "Base Concepts",
       "pages": [
         "concepts/authentication",
-        "concepts/rate-limits",
+        "concepts/rate-limits-and-quotas",
         "concepts/errors",
         "concepts/paging"
       ]

docs/snippets/global-search-api-quota-note.mdx

@@ -0,0 +1,3 @@
+<Note>
+This endpoint is subject to quotas, [read more here <Icon icon="book" size={16} />](/concepts/rate-limits-and-quotas).
+</Note>