artin/OBP-API
1
0
Fork 0
mirror of https://github.com/OpenBankProject/OBP-API.git synced 2026-02-06 11:06:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix documentation corruption in rate limiting section

Browse Source 
Remove duplicate/corrupted lines that were accidentally introduced in commit 0d4a318.
The lines included:
- Duplicate 'Unlimited' bullet point
- Stray HTTP header lines (X-Rate-Limit-Remaining, X-Rate-Limit-Reset)
- Dangling opening brace

Also improved markdown formatting with blank lines before code blocks.
This commit is contained in:
simonredfern 2025-12-30 12:07:28 +01:00
parent 45f55f1ac1
commit 2bdac7d2e5
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
obp-api/src/main/resources/docs/introductory_system_documentation.md
View File

@ -2805,6 +2805,7 @@ user_consumer_limit_anonymous_access=1000
**Managing Rate Limits:**
Create rate limits:
```bash
POST /obp/v6.0.0/management/consumers/CONSUMER_ID/consumer/rate-limits
{
@ -2820,6 +2821,7 @@ POST /obp/v6.0.0/management/consumers/CONSUMER_ID/consumer/rate-limits
```
Update rate limits:
```bash
PUT /obp/v6.0.0/management/consumers/CONSUMER_ID/consumer/rate-limits/RATE_LIMITING_ID
{
@ -2835,11 +2837,13 @@ PUT /obp/v6.0.0/management/consumers/CONSUMER_ID/consumer/rate-limits/RATE_LIMIT
```
Query active rate limits (current date/time):
```bash
GET /obp/v6.0.0/management/consumers/CONSUMER_ID/active-rate-limits
```
Query active rate limits at a specific date:
```bash
GET /obp/v6.0.0/management/consumers/CONSUMER_ID/active-rate-limits/DATE
```
@ -2863,11 +2867,6 @@ X-Rate-Limit-Reset: 45
- **Aggregation**: Active limits are summed together (positive values only)
- **Single Source of Truth**: `RateLimitingUtil.getActiveRateLimitsWithIds()` calculates all active limits consistently
- **Unlimited**: A value of `-1` means unlimited for that time period
X-Rate-Limit-Remaining: 0
X-Rate-Limit-Reset: 45
{
- **Unlimited**: A value of `-1` means unlimited for that time period
### 8.5 Security Best Practices
@ -2926,6 +2925,7 @@ For comprehensive use case examples and implementation guides, see the dedicated
- **Variable Recurring Payments (VRP)** - Enable authorized applications to make multiple payments to a beneficiary over time with varying amounts, subject to pre-defined limits. See [use_cases.md](use_cases.md#1-variable-recurring-payments-vrp) for full details.
**Coming Soon:**
- Account Aggregation
- Payment Initiation Services (PIS)
- Account Information Services (AIS)