stella-ops.org/git.stella-ops.org
1
0
Fork 0
Code Issues Pull Requests Actions 2 Releases Wiki Activity
Files
d93006a8fa4d339050b67f2f510497208bd805e8
git.stella-ops.org/src/Api/StellaOps.Api.OpenApi/AGENTS.md
master 90c244948a Update AGENTS.md files across multiple modules to standardize task status update instructions and introduce a new document for Secret Leak Detection operations. 
- Modified task status update instructions in AGENTS.md files to refer to corresponding sprint files as `/docs/implplan/SPRINT_*.md` instead of `docs/implplan/SPRINTS.md`.
- Added a comprehensive document for Secret Leak Detection operations detailing scope, prerequisites, rule bundle lifecycle, enabling the analyzer, policy patterns, observability, troubleshooting, and references.
2025-11-05 11:58:32 +02:00

1.6 KiB
Raw Blame History

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.

Required Reading

  • docs/modules/platform/architecture-overview.md

Working Agreement

    1. Update task status to DOING/DONE in both correspoding sprint file /docs/implplan/SPRINT_*.md and the local TASKS.md when you start or finish work.
    1. Review this charter and the Required Reading documents before coding; confirm prerequisites are met.
    1. Keep changes deterministic (stable ordering, timestamps, hashes) and align with offline/air-gap expectations.
    1. Coordinate doc updates, tests, and cross-guild communication whenever contracts or workflows change.
    1. Revert to TODO if you pause the task without shipping changes; leave notes in commit/PR descriptions for context.