You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
-76Lines changed: 0 additions & 76 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -30,7 +30,6 @@ The API will be available at <http://localhost:3000>
30
30
- **Cache Headers**: 6-hour cache control for static data
31
31
- **Health Check**: GET `/` returns health status
32
32
- **RESTful API**: All endpoints follow REST conventions
33
-
- **Backend caching**: Some responses are cached on the backend for 1 hours to improve latency
34
33
35
34
### `GET /`
36
35
@@ -501,51 +500,6 @@ Returns a JSON object with the following schema:
501
500
]
502
501
```
503
502
504
-
### `GET /cache-stats`
505
-
506
-
Provides statistics about the API's cache.
507
-
508
-
```bash
509
-
curl --request GET \
510
-
--url 'https://{{HOST}}/v1/cache-stats'
511
-
```
512
-
513
-
Returns a JSON object with the following schema:
514
-
515
-
```json
516
-
{
517
-
"cache_hits": 12345,
518
-
"cache_misses": 6789,
519
-
"last_cleared": "2023-10-01T12:00:00Z"
520
-
}
521
-
```
522
-
523
-
### `POST /v1/cache-reset`
524
-
525
-
Resets all caches in the API. This endpoint requires a POST request.
526
-
527
-
```bash
528
-
curl --request POST \
529
-
--url 'https://{{HOST}}/v1/cache-reset'
530
-
```
531
-
532
-
Returns a JSON object with the following schema:
533
-
534
-
```json
535
-
{
536
-
"success": true,
537
-
"message": "All caches have been reset",
538
-
"before": {
539
-
"queryCache": 150,
540
-
"dateCache": 12
541
-
},
542
-
"after": {
543
-
"queryCache": 0,
544
-
"dateCache": 0
545
-
}
546
-
}
547
-
```
548
-
549
503
## Testing
550
504
551
505
```bash
@@ -667,34 +621,4 @@ Response:
667
621
}
668
622
```
669
623
670
-
## Cache Stats Private Endpoint
671
-
672
-
The Cache Stats private endpoint provides information about the API's cache performance, including cache hits, misses, and the last time the cache was cleared. This endpoint is useful for monitoring and debugging cache behavior.
0 commit comments