You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/audits/code-reviews/PR3/e35da518e543d331abf0b57fa939d682d39f5a88.md.chunk_008.md
+12-16Lines changed: 12 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -732,9 +732,9 @@ valid range so readers and JSON consumers have clear expectations.
732
732
733
733
### docs/api/anomaly-radar-slo-budget.md:124
734
734
735
-
-[] Fixed
735
+
-[x] Fixed
736
736
-[ ] Test Written
737
-
-[x] Suggestion Ignored
737
+
-[] Suggestion Ignored
738
738
739
739
```text
740
740
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
747
747
merge so clients are produced automatically.
748
748
```
749
749
750
-
> [!CAUTION]- **Rejected**
750
+
> [!note]- **Accepted**
751
751
> | Confidence | Remarks |
752
752
> |------------|---------|
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. |
758
754
>
759
-
> ## What you did instead
755
+
> ## Lesson Learned
760
756
>
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.
762
758
>
763
-
> ## Tradeoffs considered
759
+
> ## What did you do to address this feedback?
764
760
>
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.
766
762
>
767
-
> ## What would make you change your mind
763
+
> ## Regression Avoidance Strategy
768
764
>
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.
770
766
>
771
-
> ## Future Plans
767
+
> ## Notes
772
768
>
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.
0 commit comments