docs(api): document SLA/SLO targets and add NFR validation checks (#899) - #1104
Merged
Junirezz merged 1 commit intoAug 1, 2026
Merged
Conversation
|
@Francis6-git Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes #899
This PR formalizes and documents the SLA/SLO targets for API uptime and latency across the
YieldVault-RWAbackend. To prevent documentation drift over time, the implementation programmatically links the markdown documentation (docs/api/SLA_SLO.md) directly to the machine-readable configuration (docs/nfr-baselines.json) via updated NFR validation scripts.Changes Included
📄 Documentation
docs/api/SLA_SLO.md: Created dedicated document outlining overall availability targets (99.9%), max permitted monthly downtime (43.8 mins), P95/P99 latency objectives for read/write endpoints, and error budget burn rate policies.README.md: Added reference link pointing to the new SLA/SLO documentation.Configuration & Endpoint Registry
docs/nfr-baselines.json: Added Tier 2 backend targets forlatency_p99_read_ms(500ms) andlatency_p99_write_ms(1200ms).backend/src/endpointSlaRegistry.ts: UpdatedEndpointSlaAnnotationinterface to includep99BudgetMsand populated P99 latency budgets for all 11 endpoints.Validation & Testing
scripts/validate-nfr-baselines.ts:validateApiSlaSloDocContentto verify structure and heading completeness ofSLA_SLO.md.nfr-baselines.jsonmatch the public documentation verbatim.tests/validate-nfr-baselines.test.ts&tests/endpointSlaRegistry.test.ts:p99BudgetMsis defined for every endpoint and strictly exceedsp95BudgetMs.Verification
npm run validate:nfr-baselineslocally — passed successfully.CLoses #899