build: version info change

[tolgaOzen]

Summary by CodeRabbit

• New Features

  • Introduced new API endpoints for tenant management, data operations, and permission checks, enhancing functionality.
  • Expanded documentation with code samples in Go, JavaScript, and cURL for better developer guidance.

• Bug Fixes

  • Updated API version from "v1.1.1" to "v1.1.2," indicating improvements and potential bug fixes.

• Documentation

  • Enhanced API documentation with clearer request and response schemas and new response types for various operations.

[coderabbitai]

Walkthrough

The pull request updates the API version from "v1.1.1" to "v1.1.2" across multiple files, including Swagger JSON and OpenAPI specifications. It introduces new API endpoints for tenant management, data operations, and permission checks, along with modifications to existing endpoints. The documentation has been enhanced with additional examples in various programming languages. The internal versioning in the codebase has also been updated to reflect this new version.

Changes

Files	Change Summary
docs/api-reference/apidocs.swagger.json	Updated API version to "v1.1.2"; added multiple new endpoints for tenant management and data operations with detailed request/response schemas.
docs/api-reference/openapiv2/apidocs.swagger.json	Updated API version to "v1.1.2"; no changes to endpoints or schemas, maintaining backward compatibility.
internal/info.go	Updated version number from "v1.1.1" to "v1.1.2".
proto/base/v1/openapi.proto	Updated OpenAPI specification version from "v1.1.1" to "v1.1.2"; no other structural changes.

Possibly related PRs

• build: version info update #1626: This PR updates the version number in the apidocs.swagger.json, openapiv2/apidocs.swagger.json, internal/info.go, and openapi.proto files from "v1.1.0" to "v1.1.1", which is directly related to the version update in the main PR from "v1.1.1" to "v1.1.2".

🐰 In the meadow, hopping with glee,
A version update, oh what a spree!
New endpoints added, docs shining bright,
For developers’ joy, it’s a wonderful sight!
With each little change, we dance and we play,
Celebrating progress, hip-hip-hooray! 🎉

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (4)

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

Line range hint 32-1643: New endpoints are well-documented and expand API functionality.

The addition of new endpoints for tenants, bundles, data, permissions, and schemas significantly enhances the API's capabilities. The consistent structure and detailed documentation, including request/response models and multi-language code samples, are commendable.

Consider adding a brief description of when and why to use each endpoint in the summary field to provide more context for API consumers.

---

Line range hint 1644-4075: Data structure changes are appropriate and well-documented.

The addition of new data structures like BundleRunResponse, DataWriteResponse, and PermissionCheckResponse, as well as updates to existing structures, align well with the new endpoints. The descriptions provided for most fields enhance the documentation quality.

For consistency, ensure that all fields in all data structures have descriptions. Some fields might be missing descriptions, which could be added to maintain a uniform level of documentation throughout the API specification.

---

Line range hint 1-4078: Documentation is comprehensive, but could benefit from more consistency.

The API documentation is generally well-detailed, with most endpoints and data structures having thorough descriptions and examples. The inclusion of code samples in multiple languages (Go, JavaScript, cURL) is particularly helpful for developers.

To further improve the documentation:

1. Ensure all endpoints have a consistent level of detail in their descriptions.
2. Consider adding more context about when to use specific endpoints or data structures.
3. Review and fill in any missing field descriptions in data structures.

These enhancements will make the API documentation even more user-friendly and comprehensive.

---

Line range hint 1-4078: API design follows best practices with room for minor improvements.

The API design demonstrates adherence to RESTful principles, with clear resource naming, appropriate use of HTTP methods, and consistent error handling using the Status object. The implementation of pagination using continuous_token is a good approach for managing large datasets.

Consider specifying more granular success response codes for different scenarios (e.g., 201 for resource creation, 204 for successful deletions with no content) instead of using 200 for all successful operations. This would provide more precise information about the result of each operation.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 099182f and e0abeb9.

⛔ Files ignored due to path filters (1)

• pkg/pb/base/v1/openapi.pb.go is excluded by !**/*.pb.go

📒 Files selected for processing (4)

• docs/api-reference/apidocs.swagger.json (1 hunks)
• docs/api-reference/openapiv2/apidocs.swagger.json (1 hunks)
• internal/info.go (1 hunks)
• proto/base/v1/openapi.proto (1 hunks)

✅ Files skipped from review due to trivial changes (2)

• docs/api-reference/openapiv2/apidocs.swagger.json
• proto/base/v1/openapi.proto

🔇 Additional comments (3)

internal/info.go (2)

Line range hint 1-71: No further changes needed in this file.

The version update is isolated and doesn't require any other modifications to this file. The PrintBanner function will automatically use the new version number when called.

---

26-26: Version bump looks good. Verify release notes.

The version has been updated from v1.1.1 to v1.1.2, which appears to be a minor version bump. This change is correct and doesn't introduce any syntax errors.

To ensure consistency, please verify that:

1. This version bump is intentional and matches the project's versioning strategy.
2. The release notes or changelog have been updated to reflect the changes in this new version.

You can run the following script to check for any mentions of the new version in other files:

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

6-6: Version update looks good.

The API version has been correctly updated from v1.1.1 to v1.1.2. This minor version increment aligns well with the addition of new endpoints and data structures, indicating non-breaking changes and new features.