Skip to content

docs: update API version to v1.3.7 for Swagger and Protobuf files #2177

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 1 commit into from
Apr 17, 2025
Merged

docs: update API version to v1.3.7 for Swagger and Protobuf files #2177

tolgaozen merged 1 commit into from
Apr 17, 2025

Conversation

@tolgaozen
Copy link
Member

@tolgaozen tolgaozen commented Apr 17, 2025 •
edited by coderabbitai bot
Loading

Summary by CodeRabbit

  • Documentation

    • Updated API documentation to reflect version v1.3.7.

  • Chores

    • Incremented the application version to v1.3.7.

@coderabbitai
Copy link

coderabbitai bot commented Apr 17, 2025 •
edited
Loading

Walkthrough

This change updates the Permify API version from "v1.3.6" to "v1.3.7" across multiple files. The update affects the version string in the Swagger JSON documentation, the OpenAPI proto file, and the internal version constant. No modifications were made to API endpoints, schemas, or logic—only the version metadata was incremented to reflect a new release.

Changes

File(s) Summary
docs/api-reference/apidocs.swagger.json
docs/api-reference/openapiv2/apidocs.swagger.json		 Updated the API version string from v1.3.6 to v1.3.7 in the Swagger JSON documentation.
internal/info.go Updated the internal version constant from v1.3.6 to v1.3.7.
proto/base/v1/openapi.proto Updated the OpenAPI specification version string from v1.3.6 to v1.3.7.

Possibly related PRs

  • Permify/permify#2060: Updates API version strings and internal version constant in the same set of files for a previous version increment.
  • Permify/permify#1762: Performs a similar version string update in API documentation and internal constants without other changes.
  • Permify/permify#1597: Increments version strings in the same files, representing a previous version bump.

Poem

A hop, a skip, a version jump—
From six to seven, thumpity-thump!
No code was changed, no logic bent,
Just numbers nudged with good intent.
🐇✨
The docs now gleam with version pride,
As Permify keeps its stride!

Tip

⚡💬 Agentic Chat (Pro Plan, General Availability)
  • We're introducing multi-step agentic chat in review comments and issue comments, within and outside of PR's. This feature enhances review and issue discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments and add commits to existing pull requests.
📜 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 7e879f6 and 5649f44.

⛔ 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)
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: Analyze (go)
  • GitHub Check: Test with Coverage
  • GitHub Check: Test with Coverage
🔇 Additional comments (4)
proto/base/v1/openapi.proto (1)

12-12: Approve OpenAPI proto version bump
The version field in the Swagger annotations is correctly updated from "v1.3.6" to "v1.3.7".

internal/info.go (1)

26-26: Approve internal version constant update
The Version constant has been updated to "v1.3.7", ensuring banners and logs reflect the new release.

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

6-6: Approve Swagger JSON version update
The version under info is updated to "v1.3.7", consistent with the API proto and internal version.

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

6-6: Version bump to v1.3.7 applied correctly

The info.version field in the Swagger JSON has been updated from v1.3.6 to v1.3.7 to match the new release metadata.

✨ 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.

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 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 2b4a84b into master Apr 17, 2025
13 checks passed
@tolgaozen tolgaozen deleted the update-permify-api-version-v1.3.7 branch April 17, 2025 12:06
@coderabbitai coderabbitai bot mentioned this pull request May 12, 2025
Merged
@coderabbitai coderabbitai bot mentioned this pull request Oct 24, 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