Skip to content

docs: remove observability adapter API specs and source from the openchoreo repo#720

Merged
sameerajayasoma merged 1 commit into
openchoreo:mainfrom
akila-i:repoint-adapter-specs-to-openchoreo
Jun 16, 2026
Merged

docs: remove observability adapter API specs and source from the openchoreo repo#720
sameerajayasoma merged 1 commit into
openchoreo:mainfrom
akila-i:repoint-adapter-specs-to-openchoreo

Conversation

@akila-i

@akila-i akila-i commented Jun 15, 2026

Copy link
Copy Markdown
Contributor

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

  • Updated sidebars.ts if adding a new documentation page
  • Run npm run start to preview the changes locally
  • Run npm run build to ensure the build passes without errors
  • Verified all links are working (no broken links)

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>
@coderabbitai

coderabbitai Bot commented Jun 15, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

📝 Walkthrough

Walkthrough

Three local OpenAPI YAML spec files (observability-logs-adapter-api.yaml, observability-metrics-adapter.yaml, observability-tracing-adapter-api.yaml) are deleted from static/api-specs/. The SwaggerUI specUrl in the three corresponding MDX documentation pages is updated from local /api-specs/ paths to GitHub raw content URLs pointing to the upstream openchoreo repository.

Changes

Observability Adapter API Spec Migration

Layer / File(s) Summary
SwaggerUI specUrl redirected to GitHub raw URLs
docs/platform-engineer-guide/modules/observability-logging-adapter-api.mdx, docs/platform-engineer-guide/modules/observability-metrics-adapter-api.mdx, docs/platform-engineer-guide/modules/observability-tracing-adapter-api.mdx, static/api-specs/observability-logs-adapter-api.yaml, static/api-specs/observability-metrics-adapter.yaml, static/api-specs/observability-tracing-adapter-api.yaml
The three local OpenAPI YAML spec files (798, 920, and 439 lines respectively) are removed from static/api-specs/, and each MDX page's SwaggerUI specUrl is switched to the corresponding raw GitHub URL in the openchoreo repository.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related issues

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description check ✅ Passed The description covers the purpose, related issues, and includes a checklist matching the template, though one link verification item remains incomplete.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Title check ✅ Passed The title accurately describes the main change: removing vendored observability adapter API specs and sourcing them from the openchoreo repository instead.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@akila-i akila-i marked this pull request as ready for review June 15, 2026 12:52
@akila-i akila-i changed the title docs: source observability adapter API specs from the openchoreo repo docs: remove observability adapter API specs and source from the openchoreo repo Jun 16, 2026
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" />

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How does this work for different versions of OpenChoreo?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

specUrl is modified in versioned docs to point to the corresponding release branch

@sameerajayasoma sameerajayasoma merged commit b60e45b into openchoreo:main Jun 16, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants