Skip to content

Commit 5f0a9ea

Browse files
committed
docs: mark anomaly openapi review item resolved
1 parent c0da7e2 commit 5f0a9ea

File tree

1 file changed

+12
-16
lines changed

1 file changed

+12
-16
lines changed

docs/audits/code-reviews/PR3/e35da518e543d331abf0b57fa939d682d39f5a88.md.chunk_008.md

Lines changed: 12 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -732,9 +732,9 @@ valid range so readers and JSON consumers have clear expectations.
732732

733733
### docs/api/anomaly-radar-slo-budget.md:124
734734

735-
- [ ] Fixed
735+
- [x] Fixed
736736
- [ ] Test Written
737-
- [x] Suggestion Ignored
737+
- [ ] Suggestion Ignored
738738

739739
```text
740740
In docs/api/anomaly-radar-slo-budget.md around line 124, there is no
@@ -747,30 +747,26 @@ and generates client SDKs (specify targets, output directory, and caching) on
747747
merge so clients are produced automatically.
748748
```
749749

750-
> [!CAUTION]- **Rejected**
750+
> [!note]- **Accepted**
751751
> | Confidence | Remarks |
752752
> |------------|---------|
753-
> | 5 | Producing a full OpenAPI 3.1 spec + CI pipeline is out-of-scope for this review chunk. |
754-
>
755-
> ## Rejection Rationale
756-
>
757-
> We lack consensus on the final endpoint surface and don’t have automated validation wired up; generating an incomplete spec would be misleading.
753+
> | 8 | Added a draft OpenAPI spec plus validation workflow and linked it from the docs. |
758754
>
759-
> ## What you did instead
755+
> ## Lesson Learned
760756
>
761-
> Documented the endpoints comprehensively in markdown and continued referencing the existing admin API OpenAPI documents for guidance.
757+
> Treat the YAML spec as the source of truth and keep CI guarding it.
762758
>
763-
> ## Tradeoffs considered
759+
> ## What did you do to address this feedback?
764760
>
765-
> Building the spec now would take significant time and risk drift; deferring keeps focus on stabilising the API first.
761+
> Created `docs/api/anomaly-radar-openapi.yaml`, referenced it in the doc’s overview, and added `.github/workflows/anomaly-radar-openapi.yml` to validate the spec and dry-run TypeScript client generation on every change.
766762
>
767-
> ## What would make you change your mind
763+
> ## Regression Avoidance Strategy
768764
>
769-
> Once the anomaly radar API is stabilised and we can commit to long-term support, we can add the OpenAPI spec and CI job.
765+
> CI validation prevents drift; future doc edits can point to the shared spec.
770766
>
771-
> ## Future Plans
767+
> ## Notes
772768
>
773-
> Track the “API formalisation” epic; when prioritised we’ll emit the spec and wire the generator pipeline requested here.
769+
> Spec remains marked draft until the endpoints ship, but tooling is now in place.
774770
775771
### docs/api/anomaly-radar-slo-budget.md:176
776772

0 commit comments

Comments
 (0)