Skip to content

fix: Fixed spec endpoint BED-6941#2276

Merged
LucasParraF merged 1 commit intomainfrom
BED-6941-Fix-spec-endpoint
Jan 22, 2026
Merged

fix: Fixed spec endpoint BED-6941#2276
LucasParraF merged 1 commit intomainfrom
BED-6941-Fix-spec-endpoint

Conversation

@LucasParraF
Copy link
Contributor

@LucasParraF LucasParraF commented Jan 21, 2026

Description

Endpoint for OpenAPI spec is incorrect in API Explorer and Documentation. Should be /api/v2/spec but shows as /api/v2/spec/openapi.yaml.

Motivation and Context

Resolves BED-6941

How Has This Been Tested?

Tested locally

Types of changes

  • Bug fix (non-breaking change which fixes an issue)

Checklist:

Summary by CodeRabbit

  • API Changes
    • OpenAPI specification endpoint updated from /api/v2/spec/openapi.yaml to /api/v2/spec. Developers accessing the API documentation should update their references to the new simplified endpoint path.

✏️ Tip: You can customize this high-level summary in your review settings.

@LucasParraF LucasParraF self-assigned this Jan 21, 2026
@LucasParraF LucasParraF added bug Something isn't working api A pull request containing changes affecting the API code. labels Jan 21, 2026
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 21, 2026

Walkthrough

The OpenAPI endpoint path was changed from /api/v2/spec/openapi.yaml to /api/v2/spec across the source and compiled OpenAPI specification files. The endpoint continues to serve the same OpenAPI spec without functional alterations.

Changes

Cohort / File(s) Summary
OpenAPI Specification Path Updates
packages/go/openapi/doc/openapi.json, packages/go/openapi/src/openapi.yaml
Endpoint path simplified from /api/v2/spec/openapi.yaml to /api/v2/spec in both the source OpenAPI YAML definition and the compiled JSON documentation. Path routes to the same spec resource.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 A path once long, now short and sweet,
/api/v2/spec makes it neat!
The spec still serves with grace,
Just cleaner, simpler space. 🎉

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description check ✅ Passed The description follows the template structure with all required sections: Description, Motivation and Context (with ticket reference), How Has This Been Tested, Types of changes, and a completed checklist.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Title check ✅ Passed The title clearly describes the main change: correcting the OpenAPI spec endpoint path from '/api/v2/spec/openapi.yaml' to '/api/v2/spec'.

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

✨ Finishing touches
  • 📝 Generate docstrings

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.

@LucasParraF LucasParraF changed the title fix: Fixed spec endpoint fix: Fixed spec endpoint BED-6941 Jan 21, 2026
Copy link
Member

@AD7ZJ AD7ZJ left a comment

Choose a reason for hiding this comment

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

Looks good, thanks for fixing that!

@LucasParraF LucasParraF merged commit 004d083 into main Jan 22, 2026
13 of 14 checks passed
@LucasParraF LucasParraF deleted the BED-6941-Fix-spec-endpoint branch January 22, 2026 15:00
@github-actions github-actions bot locked and limited conversation to collaborators Jan 22, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

api A pull request containing changes affecting the API code. bug Something isn't working

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants