Restructure solution layout by module
This commit is contained in:
15
src/Api/StellaOps.Api.Governance/AGENTS.md
Normal file
15
src/Api/StellaOps.Api.Governance/AGENTS.md
Normal file
@@ -0,0 +1,15 @@
|
||||
# API Governance Guild Charter
|
||||
|
||||
## Mission
|
||||
Enforce API contract quality through linting, compatibility checks, version policy automation, and changelog generation.
|
||||
|
||||
## Scope
|
||||
- Maintain lint rule set, compatibility diff tooling, and CI integration.
|
||||
- Gate PRs on contract validation, example coverage, and naming conventions.
|
||||
- Produce automated changelogs and deprecation notices from OAS diffs.
|
||||
- Coordinate with Notifications Studio for deprecation broadcasts.
|
||||
|
||||
## Definition of Done
|
||||
- CI gate prevents merging incompatible or non-conforming specs.
|
||||
- Version bump tooling produces signed changelog artifacts per release.
|
||||
- Governance documentation kept current in `/docs/contributing/api-contracts.md`.
|
||||
18
src/Api/StellaOps.Api.Governance/TASKS.md
Normal file
18
src/Api/StellaOps.Api.Governance/TASKS.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# API Governance Task Board — Epic 17: SDKs & OpenAPI Docs
|
||||
|
||||
## Sprint 61 – Lint & CI Integration
|
||||
| ID | Status | Owner(s) | Depends on | Description | Exit Criteria |
|
||||
|----|--------|----------|------------|-------------|---------------|
|
||||
| APIGOV-61-001 | TODO | API Governance Guild | OAS-61-002 | Configure spectral/linters with Stella rules; add CI job failing on violations. | Lint pipeline runs on PRs; rule set documented; intentional violations blocked. |
|
||||
| APIGOV-61-002 | TODO | API Governance Guild | APIGOV-61-001 | Implement example coverage checker ensuring every operation has at least one request/response example. | Coverage job integrated; failing operations listed in CI output. |
|
||||
|
||||
## Sprint 62 – Compatibility & Changelog
|
||||
| ID | Status | Owner(s) | Depends on | Description | Exit Criteria |
|
||||
|----|--------|----------|------------|-------------|---------------|
|
||||
| APIGOV-62-001 | TODO | API Governance Guild | APIGOV-61-001 | Build compatibility diff tool producing additive/breaking reports comparing prior release. | Diff output consumed in CI; failing on breaking changes unless override provided. |
|
||||
| APIGOV-62-002 | TODO | API Governance Guild, DevOps Guild | APIGOV-62-001 | Automate changelog generation and publish signed artifacts to `src/Sdk/StellaOps.Sdk.Release` pipeline. | Changelog pipeline produces markdown + JSON; signatures verified; docs updated. |
|
||||
|
||||
## Sprint 63 – Deprecation & Notifications
|
||||
| ID | Status | Owner(s) | Depends on | Description | Exit Criteria |
|
||||
|----|--------|----------|------------|-------------|---------------|
|
||||
| APIGOV-63-001 | TODO | API Governance Guild, Notifications Guild | APIGOV-62-002 | Integrate deprecation metadata into Notification Studio templates for API sunset events. | Deprecation pipeline triggers notifier template; staging test proves delivery. |
|
||||
Reference in New Issue
Block a user