ea970ead2a
Some checks failed
Docs CI / lint-and-preview (push) Has been cancelled
sdk-generator-smoke / sdk-smoke (push) Has been cancelled
SDK Publish & Sign / sdk-publish (push) Has been cancelled
api-governance / spectral-lint (push) Has been cancelled
oas-ci / oas-validate (push) Has been cancelled
Mirror Thin Bundle Sign & Verify / mirror-sign (push) Has been cancelled
6.3 KiB
6.3 KiB
Sprint 511 - Ops & Offline · 190.F) Api
Active items only. Completed/historic work now resides in docs/implplan/archived/tasks.md (updated 2025-11-08).
[Ops & Offline] 190.F) Api Depends on: Sprint 100.A - Attestor, Sprint 110.A - AdvisoryAI, Sprint 120.A - AirGap, Sprint 130.A - Scanner, Sprint 140.A - Graph, Sprint 150.A - Orchestrator, Sprint 160.A - EvidenceLocker, Sprint 170.A - Notifier, Sprint 180.A - Cli Summary: Ops & Offline focus on Api).
| Task ID | State | Task description | Owners (Source) |
|---|---|---|---|
| APIGOV-61-001 | DONE (2025-11-18) | Spectral config + CI workflow added; npm script api:lint runs spectral via npx. |
API Governance Guild (src/Api/StellaOps.Api.Governance) |
| APIGOV-61-002 | DONE (2025-11-18) | Implement example coverage checker ensuring every operation has at least one request/response example. Dependencies: APIGOV-61-001. | API Governance Guild (src/Api/StellaOps.Api.Governance) |
| APIGOV-62-001 | DONE (2025-11-18) | Build compatibility diff tool producing additive/breaking reports comparing prior release. Dependencies: APIGOV-61-002. | API Governance Guild (src/Api/StellaOps.Api.Governance) |
| APIGOV-62-002 | DONE (2025-11-24) | Automate changelog generation and publish signed artifacts to src/Sdk/StellaOps.Sdk.Release pipeline. Dependencies: APIGOV-62-001. |
API Governance Guild, DevOps Guild (src/Api/StellaOps.Api.Governance) |
| APIGOV-63-001 | BLOCKED | Notification Studio templates and deprecation metadata schema not present; waiting on Notifications Guild assets. | API Governance Guild, Notifications Guild (src/Api/StellaOps.Api.Governance) |
| OAS-61-001 | DONE (2025-11-18) | Scaffold per-service OpenAPI 3.1 files with shared components, info blocks, and initial path stubs. | API Contracts Guild (src/Api/StellaOps.Api.OpenApi) |
| OAS-61-002 | DONE (2025-11-18) | Implement aggregate composer (stella.yaml) resolving $refs and merging shared components; wire into CI. Dependencies: OAS-61-001. |
API Contracts Guild, DevOps Guild (src/Api/StellaOps.Api.OpenApi) |
| OAS-62-001 | DONE (2025-11-26) | Added examples for Authority, Policy, Orchestrator, Scheduler, Export, Graph stubs; shared error envelopes cover standard errors. Remaining services will be added when their stubs land. | API Contracts Guild, Service Guilds (src/Api/StellaOps.Api.OpenApi) |
| OAS-62-002 | DONE (2025-11-26) | Spectral rules now enforce list pagination params, 201/202 idempotency headers, and lowerCamel operationIds; orchestrator jobs list includes cursor. | API Contracts Guild (src/Api/StellaOps.Api.OpenApi) |
| OAS-63-001 | DONE (2025-11-26) | Compat diff reports parameter adds/removals/requiredness, request bodies, and response content-type changes; fixtures/tests updated. | API Contracts Guild (src/Api/StellaOps.Api.OpenApi) |
| OAS-63-002 | DONE (2025-11-24) | Add /.well-known/openapi discovery endpoint schema metadata (extensions, version info). Dependencies: OAS-63-001. |
API Contracts Guild, Gateway Guild (src/Api/StellaOps.Api.OpenApi) |
Execution Log
| Date (UTC) | Update | Owner |
|---|---|---|
| 2025-11-08 | Archived completed/historic work to docs/implplan/archived/tasks.md (updated 2025-11-08). | Planning |
| 2025-11-18 | Added Spectral config (.spectral.yaml), npm api:lint (npx spectral) script, and CI workflow .gitea/workflows/api-governance.yml; marked APIGOV-61-001 DONE. |
API Governance Guild |
| 2025-11-18 | Implemented example coverage checker (api:examples), aggregate composer compose.mjs, and initial per-service OAS stubs (authority/orchestrator/policy/export-center); OAS-61-001/002 set to DONE. |
API Contracts Guild |
| 2025-11-19 | Added scheduler/export-center/graph shared endpoints, shared paging/security components, and CI diff gates (previous commit + baseline). Created baseline stella-baseline.yaml. |
API Contracts Guild |
| 2025-11-19 | Implemented API changelog generator (api:changelog), wired compose/examples/compat/changelog into CI, and added new policy revisions + scheduler queue/job endpoints. |
API Contracts Guild |
| 2025-11-24 | Completed OAS-63-002: documented discovery payload for /.well-known/openapi in docs/api/openapi-discovery.md with extensions/version metadata. |
Implementer |
| 2025-11-24 | Completed APIGOV-62-002: api:changelog now copies release-ready artifacts + digest/signature to src/Sdk/StellaOps.Sdk.Release/out/api-changelog for SDK pipeline consumption. |
Implementer |
| 2025-11-26 | Added request/response examples to Authority token/introspect/revoke/JWKS endpoints and updated OAS-62-001 status to DOING. | Implementer |
| 2025-11-26 | Added policy /evaluate allow/deny examples, sample request, and /policies list example + schema stub; sprint status OAS-62-001 remains DOING. |
Implementer |
| 2025-11-26 | Added Orchestrator /jobs list examples (filtered + mixed queues) and invalid status error; bumped orchestrator OAS version to 0.0.2. |
Implementer |
| 2025-11-26 | Added Scheduler queue examples (empty + snapshot) and Export Center bundle/list/manifest examples; bumped scheduler/export OAS versions to 0.0.2. | Implementer |
| 2025-11-26 | Added Graph status/nodes examples with tenant context; bumped graph OAS version to 0.0.2. | Implementer |
| 2025-11-26 | Added auth (Bearer/client-credentials) security blocks to Export Center bundle endpoints. | Implementer |
| 2025-11-26 | Marked OAS-62-001 DONE after covering Authority/Policy/Orchestrator/Scheduler/Export/Graph stubs with examples; remaining services will be covered once stubs are available. | Implementer |
| 2025-11-26 | Added Spectral rules for 2xx examples and Idempotency-Key on /jobs; refreshed stella.yaml/baseline and ran npm run api:lint (warnings only). OAS-62-002 → DOING. |
Implementer |
| 2025-11-26 | Declared aggregate tags in compose, removed unused HealthResponse, regenerated baseline; npm run api:lint now passes with zero warnings. |
Implementer |
| 2025-11-26 | Tightened lint: list/search GETs require limit+cursor, 201/202 writers require Idempotency-Key; added cursor to orchestrator /jobs, recomposed stella.yaml/baseline; npm run api:lint clean. |
Implementer |
| 2025-11-26 | Enhanced api-compat-diff to report parameter, request body, and response content-type changes; refreshed fixtures/tests; marked OAS-62-002 and OAS-63-001 DONE. |
Implementer |
| 2025-11-19 | Marked OAS-62-001 BLOCKED pending OAS-61-002 ratification and approved examples/error envelope. | Implementer |