Conversation
There was a problem hiding this comment.
Pull request overview
Adds initial documentation for SLI (Service Level Indicator) collection/exposure in the CDP codebase, plus a root README entry point to that documentation.
Changes:
- Added
docs/sli/README.mddescribing SLI architecture, available SLI types, and an API endpoint for exposure. - Added a root
README.mdlinking to the SLI documentation.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
| docs/sli/README.md | New SLI documentation (overview, Mermaid diagram, SLI list, and API example). |
| README.md | New root documentation index linking to the SLI docs. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
docs/sli/README.md
Outdated
| - Endpoint: `GET storage-providers/average-monthly-sli` | ||
| - Format: `JSON` | ||
| - Example: | ||
|
|
||
| ```curl -X 'GET' \ | ||
| https://cdp.allocator.tech/storage-providers/average-monthly-sli?storageProvidersIds=f03623017&storageProvidersIds=f03644168' \ |
There was a problem hiding this comment.
The endpoint path is missing a leading / (controller is @Controller('storage-providers') and @Get('/average-monthly-sli')), and the curl example appears to have broken quoting (extra trailing ' after the last storageProvidersIds value, and the URL itself isn’t wrapped in quotes). This makes the example non-copy-pastable.
| - Endpoint: `GET storage-providers/average-monthly-sli` | |
| - Format: `JSON` | |
| - Example: | |
| ```curl -X 'GET' \ | |
| https://cdp.allocator.tech/storage-providers/average-monthly-sli?storageProvidersIds=f03623017&storageProvidersIds=f03644168' \ | |
| - Endpoint: `GET /storage-providers/average-monthly-sli` | |
| - Format: `JSON` | |
| - Example: | |
| ```curl -X 'GET' \ | |
| 'https://cdp.allocator.tech/storage-providers/average-monthly-sli?storageProvidersIds=f03623017&storageProvidersIds=f03644168' \ |
|
|
||
| ## Overview | ||
|
|
||
| ... |
There was a problem hiding this comment.
The root README currently contains a placeholder ... in the Overview section. If this README is intended to be user-facing project documentation, please replace the placeholder with a minimal real overview (or remove the section) so the repo doesn’t ship incomplete docs.
| ... | |
| The Compliance Data Platform (CDP) centralizes and standardizes compliance-related data to support monitoring, reporting, and governance across services. This repository contains the core documentation and supporting materials for working with CDP, including service-level indicators (SLIs) and related implementation guidance. |
No description provided.