Skip to content

docs: update API versions to v1.3.4 #2108

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
merged 1 commit into from
Mar 10, 2025
Merged

docs: update API versions to v1.3.4 #2108

merged 1 commit into from
Mar 10, 2025

Conversation

tolgaozen
Copy link
Member

@tolgaozen tolgaozen commented Mar 10, 2025 •
edited by coderabbitai bot
Loading

Summary by CodeRabbit

  • Documentation

    • Updated the public API documentation to clearly display version v1.3.4, ensuring all consumers see consistent release details across our published resources without affecting functionality.

  • Chores

    • Synchronized version information across all components for consistency, reflecting our commitment to clear and accurate versioning in this release.

@coderabbitai coderabbitai
Copy link

coderabbitai bot commented Mar 10, 2025 •
edited
Loading

Walkthrough

The pull request updates the version number for the Permify API across multiple files. The change increments the version from "v1.3.3" to "v1.3.4" in API documentation files (Swagger JSON and OpenAPI specification), the internal Go info file, and the proto file. No other modifications or structural changes are included in this update.

Changes

File(s) Change Summary
docs/api-reference/apidocs.swagger.json
docs/api-reference/openapiv2/apidocs.swagger.json		 Updated the version from v1.3.3 to v1.3.4 in the API information sections of the Swagger JSON files.
internal/info.go Updated the Version constant from v1.3.3 to v1.3.4.
proto/base/v1/openapi.proto Updated the version field from v1.3.3 to v1.3.4 in the OpenAPI specification.

Possibly related PRs

Poem

I'm a rabbit who loves to hop,
Through code fields where changes never stop.
I've seen v1.3.3 turn to v1.3.4— hooray!
In docs and code, we now sashay.
With cuddly bytes and carrot dreams,
I celebrate these version gleams!
🥕🐇

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 golangci-lint (1.62.2)

level=warning msg="[config_reader] The configuration option run.skip-dirs is deprecated, please use issues.exclude-dirs."
level=warning msg="[config_reader] The configuration option linters.govet.check-shadowing is deprecated. Please enable shadow instead, if you are not using enable-all."
level=warning msg="[config_reader] The configuration option linters.gci.local-prefixes is deprecated, please use prefix() inside linters.gci.sections."
Error: can't load config: the Go language version (go1.23) used to build golangci-lint is lower than the targeted Go version (1.24)
Failed executing command with error: can't load config: the Go language version (go1.23) used to build golangci-lint is lower than the targeted Go version (1.24)

📜 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 9e6e311 and 491d13c.

⛔ 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: API Version Update in OpenAPI Specification
The version string is correctly updated from "v1.3.3" to "v1.3.4" in the OpenAPI options. This simple bump aligns with the PR objectives and maintains consistency with similar changes across the codebase.

internal/info.go (1)

26-26: Version Constant Update
The Version constant is updated to "v1.3.4", which is consistent with the changes in the API documentation. This ensures that the internal information reflects the current release version accurately.

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

6-6: Swagger API Version Consistency
The version field in the Swagger JSON is now "v1.3.4", matching the updates in the other files. This change is straightforward and meets the PR objective for version consistency.

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

6-6: API Version Update Confirmed

The API version has been updated to "v1.3.4" as required by the PR objectives. This change is clear and consistent with the overall update strategy. Please verify that all other API documentation references in similar files (e.g. OpenAPI, proto files, etc.) are aligned with this version update.

✨ 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 4aaafab into master Mar 10, 2025
11 checks passed
@tolgaozen tolgaozen deleted the update-permify-api-v1.3.4 branch March 10, 2025 07:21
@coderabbitai coderabbitai bot mentioned this pull request Mar 27, 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.
1 participant
@tolgaozen
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy