Restructure solution layout by module
This commit is contained in:
16
src/Api/StellaOps.Api.OpenApi/AGENTS.md
Normal file
16
src/Api/StellaOps.Api.OpenApi/AGENTS.md
Normal file
@@ -0,0 +1,16 @@
|
||||
# StellaOps API Contracts Guild Charter
|
||||
|
||||
## Mission
|
||||
Maintain OpenAPI 3.1 specifications for every StellaOps service, compose the aggregate spec, and ensure API contract consistency across releases.
|
||||
|
||||
## Scope
|
||||
- Author and review per-service OAS documents in `src/Api/StellaOps.Api.OpenApi/<service>/openapi.yaml`.
|
||||
- Operate the aggregate composer producing `src/Api/StellaOps.Api.OpenApi/stella.yaml`.
|
||||
- Provide shared components, schema libraries, and example catalogs.
|
||||
- Coordinate with service guilds on contract changes, examples, and versioning.
|
||||
- Own CI validation, linting, and compatibility diff tooling for OAS artifacts.
|
||||
|
||||
## Definition of Done
|
||||
- All public endpoints represented in OAS with validated request/response examples.
|
||||
- Aggregate spec builds deterministically and passes lint + compatibility checks.
|
||||
- Change logs generated with every release and linked to developer portal updates.
|
||||
Reference in New Issue
Block a user