Skip to content

Add SLI docs#234

Open
lukasz-wal wants to merge 1 commit intomainfrom
sli-docs
Open

Add SLI docs#234
lukasz-wal wants to merge 1 commit intomainfrom
sli-docs

Conversation

@lukasz-wal
Copy link
Copy Markdown
Collaborator

No description provided.

Copilot AI review requested due to automatic review settings March 26, 2026 09:21
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.md describing SLI architecture, available SLI types, and an API endpoint for exposure.
  • Added a root README.md linking 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.

Comment on lines +80 to +85
- 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' \
Copy link

Copilot AI Mar 26, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Suggested change
- 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' \

Copilot uses AI. Check for mistakes.

## Overview

...
Copy link

Copilot AI Mar 26, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Suggested change
...
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.

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants