Skip to content

feat: add Secret Management API specification (OpenAPI 3.1) #57

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 16, 2025
Merged

feat: add Secret Management API specification (OpenAPI 3.1) #57

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
597afaf
feat: add Secret Management API specification (OpenAPI 3.1)
kevalyq Nov 16, 2025
aa26759
fix: address Copilot review comments on Secret API spec
kevalyq Nov 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

### Added

- **Secret Management API Specification**: Complete OpenAPI 3.1 spec for Secret CRUD and Sharing endpoints
- **5 Secret CRUD endpoints**: `GET /secrets`, `POST /secrets`, `GET /secrets/{secret}`, `PATCH /secrets/{secret}`, `DELETE /secrets/{secret}`
- **3 Secret Sharing endpoints**: `GET /secrets/{secret}/shares`, `POST /secrets/{secret}/shares`, `DELETE /secrets/{secret}/shares/{share}`
- **Schemas**: `Secret` (with encrypted fields), `SecretShare` (with permission hierarchy)
- **Validation Rules**: Field lengths, required fields, permission enums (`read`, `write`, `admin`)
- **XOR Constraint**: Share with user OR role (not both) - documented in spec
- **Permission Hierarchy**: admin > write > read - documented with examples
- **Error Responses**: 400, 401, 403, 404, 422 with detailed examples
- **Authentication**: Bearer token (JWT) required for all endpoints
- **Pagination**: List endpoints support `page` and `per_page` query parameters
- Related: Implements spec for SecPal/api PRs #183, #185 (Phase 3: Secret Sharing & Access Control)

- **Git Conflict Marker Detection**: Automated check for unresolved merge conflicts
- `scripts/check-conflict-markers.sh` - Scans all tracked files for conflict markers (`<<<<<<<`, `=======`, `>>>>>>>`, `|||||||`)
- `.github/workflows/check-conflict-markers.yml` - CI integration (runs on all PRs and pushes to main)
Expand Down
Loading