Skip to content

docs: update API version to v1.3.8 in swagger files #2226

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
tolgaozen merged 2 commits into from
May 12, 2025
Merged

docs: update API version to v1.3.8 in swagger files #2226

tolgaozen merged 2 commits into from
May 12, 2025

Conversation

@tolgaozen
Copy link
Member

@tolgaozen tolgaozen commented May 12, 2025 •
edited by coderabbitai bot
Loading

Summary by CodeRabbit

  • Documentation

    • Updated API documentation to reflect version v1.3.8.

  • Style

    • Adjusted table header formatting in configuration display with improved error handling.

  • Chores

    • Incremented application version to v1.3.8 across relevant files.

@coderabbitai
Copy link

coderabbitai bot commented May 12, 2025 •
edited
Loading

Walkthrough

This change updates the Permify API version from "v1.3.7" to "v1.3.8" across documentation files, internal constants, and proto definitions. Additionally, it modifies the way table headers are set in the renderConfigTable function within the CLI configuration code, removing explicit column alignment and separator settings, and adds error handling for table operations.

Changes

File(s) Change Summary
docs/api-reference/apidocs.swagger.json
docs/api-reference/openapiv2/apidocs.swagger.json
proto/base/v1/openapi.proto		 Updated API version string from "v1.3.7" to "v1.3.8" in documentation and proto files.
internal/info.go Updated the internal Version constant from "v1.3.7" to "v1.3.8".
pkg/cmd/config.go Changed table header setup in renderConfigTable, replacing SetHeader with Header, removing explicit column alignment and separator configuration, and added error handling for Append and Render calls.

Possibly related PRs

Poem

🐇
A hop to v1.3.8,
Our docs and code align straight.
Table headers now look neat,
With version bumps, our work’s complete.
Permify marches, never late—
Another update, isn’t it great?
🥕

Tip

⚡️ Faster reviews with caching
  • CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.

Enjoy the performance boost—your workflow just got faster.

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0319a35 and 13e91e8.

📒 Files selected for processing (1)
  • pkg/cmd/config.go (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • pkg/cmd/config.go
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: Test with Coverage
  • GitHub Check: Analyze (go)
  • GitHub Check: Test with Coverage
✨ 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
🪧 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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

@tolgaozen tolgaozen merged commit ce30028 into master May 12, 2025
11 checks passed
@tolgaozen tolgaozen deleted the update-api-versions-v1.3.8 branch May 12, 2025 08:31
@coderabbitai coderabbitai bot mentioned this pull request Jun 5, 2025
Merged
@coderabbitai coderabbitai bot mentioned this pull request Oct 24, 2025
Merged
@coderabbitai coderabbitai bot mentioned this pull request Nov 3, 2025
Merged
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

@tolgaozen