Skip to content

chore: update version to v1.6.0 in API docs and internal info file #2716

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
ucatbas merged 1 commit into from
Dec 28, 2025
Merged

chore: update version to v1.6.0 in API docs and internal info file #2716

ucatbas merged 1 commit into from
Dec 28, 2025
+7 −6

Conversation

@ucatbas
Copy link
Contributor

@ucatbas ucatbas commented Dec 28, 2025 •
edited by coderabbitai bot
Loading

Summary by CodeRabbit

  • Chores
    • Version updated to v1.6.0 across API documentation and internal version references.

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

@coderabbitai
Copy link

coderabbitai bot commented Dec 28, 2025 •
edited
Loading

📝 Walkthrough

Walkthrough

This pull request updates the API version from v1.5.4 to v1.6.0 across API documentation files and the internal version constant, with no functional or structural changes.

Changes

Cohort / File(s) Summary
API Documentation
docs/api-reference/apidocs.swagger.json, docs/api-reference/openapi.json, docs/api-reference/openapiv2/apidocs.swagger.json, proto/base/v1/openapi.proto		 Updated OpenAPI/Swagger version metadata from v1.5.4 to v1.6.0
Internal Version Constant
internal/info.go		 Updated exported Version constant from "v1.5.4" to "v1.6.0"

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

Suggested reviewers

  • tolgaozen

Poem

🐰 A version bump, oh what delight!
From one-five-four to six so bright,
Through docs and code, the numbers flow,
A rabbit's joy to see them grow! 🎉

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and specifically describes the main change: updating the version to v1.6.0 across API documentation and internal info files, which matches the changeset.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch update/api-version-to-v1.6.0
📜 Recent review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b49da07 and c635b3a.

⛔ Files ignored due to path filters (2)
  • go.work.sum is excluded by !**/*.sum
  • pkg/pb/base/v1/openapi.pb.go is excluded by !**/*.pb.go
📒 Files selected for processing (5)
  • docs/api-reference/apidocs.swagger.json
  • docs/api-reference/openapi.json
  • docs/api-reference/openapiv2/apidocs.swagger.json
  • internal/info.go
  • proto/base/v1/openapi.proto
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)
  • GitHub Check: Analyze (go)
  • GitHub Check: Test with Coverage
  • GitHub Check: Scan Container for Vulnerabilities
  • GitHub Check: Test with Coverage
🔇 Additional comments (5)
docs/api-reference/openapiv2/apidocs.swagger.json (1)

6-6: API info.version correctly bumped to v1.6.0

The OpenAPI v2 document’s info.version matches the target release version and does not affect paths or schemas. Looks good.

docs/api-reference/apidocs.swagger.json (1)

6-6: API info.version updated consistently to v1.6.0

Top-level info.version is aligned with the new release version; no other doc structure changes. All good.

proto/base/v1/openapi.proto (1)

12-12: Version update is correct.

The version string is properly updated to reflect the v1.6.0 release. Metadata-only change with no impact on the API contract.

docs/api-reference/openapi.json (1)

6-6: Version update is correct.

The version string is properly updated in the OpenAPI info section. All API paths, schemas, and definitions remain unchanged.

internal/info.go (1)

26-26: Version constant is correctly updated.

The exported Version constant now reflects v1.6.0 and will be correctly displayed in the banner output via the PrintBanner() function.

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.

@codecov
Copy link

codecov bot commented Dec 28, 2025 •
edited
Loading

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 82.56%. Comparing base (b49da07) to head (c635b3a).
⚠️ Report is 2 commits behind head on master.

Additional details and impacted files 
@@            Coverage Diff             @@
##           master    #2716      +/-   ##
==========================================
+ Coverage   82.55%   82.56%   +0.02%     
==========================================
  Files          74       74              
  Lines        8125     8125              
==========================================
+ Hits         6707     6708       +1     
+ Misses        903      902       -1     
  Partials      515      515

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@ucatbas ucatbas merged commit a435714 into master Dec 28, 2025
15 of 16 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@ucatbas