docs: remove observability adapter API specs and source from the openchoreo repo#720
Conversation
The logs, metrics, and tracing adapter OpenAPI specs now live in the openchoreo repo under openapi/. Point the SwaggerUI references at the raw spec URLs there and drop the vendored copies from static/api-specs/ so the openchoreo repo is the single source of truth. Signed-off-by: Akila-I <akila.99g@gmail.com>
📝 WalkthroughWalkthroughThree local OpenAPI YAML spec files ( ChangesObservability Adapter API Spec Migration
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related issues
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
| For an overview of the adapter pattern and how it fits into the observability architecture, see [Building an Observability Module](../building-a-module#observability-modules). | ||
|
|
||
| <SwaggerUI specUrl="/api-specs/observability-logs-adapter-api.yaml" /> | ||
| <SwaggerUI specUrl="https://raw.githubusercontent.com/openchoreo/openchoreo/main/openapi/observability-logs-adapter-api.yaml" /> |
There was a problem hiding this comment.
How does this work for different versions of OpenChoreo?
There was a problem hiding this comment.
specUrl is modified in versioned docs to point to the corresponding release branch
Purpose
The logs, metrics, and tracing adapter OpenAPI specs now live in the openchoreo repo under openapi/. Point the SwaggerUI references at the raw spec URLs there and drop the vendored copies from static/api-specs/ so the openchoreo repo is the single source of truth.
Adapter API specs were moved to openchroeo repo via following PRs
openchoreo/openchoreo#3843
openchoreo/openchoreo#3847
openchoreo/openchoreo#3848
openchoreo/openchoreo#3849
openchoreo/openchoreo#3851
Related Issues
openchoreo/openchoreo#3842
Checklist
sidebars.tsif adding a new documentation pagenpm run startto preview the changes locallynpm run buildto ensure the build passes without errors