这是indexloc提供的服务，不要输入任何密码
Skip to content

docs: upgrade guide from v1.0 to v1.1 #1608

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 4 commits into from
Sep 19, 2024
Merged

docs: upgrade guide from v1.0 to v1.1 #1608

merged 4 commits into from
Sep 19, 2024

Conversation

@tolgaozen
Copy link
Member

@tolgaozen tolgaozen commented Sep 19, 2024 •
edited by coderabbitai bot
Loading

Summary by CodeRabbit

Release Notes

  • New Features

    • Updated Permify API version from v1.0.7 to v1.1.0, indicating new features and improvements.
    • Introduced a new scope field in lookup APIs for enhanced query control.
    • Removed the maximum limit on page_size in lookup APIs, allowing for unlimited data retrieval.

  • Improvements

    • Enhanced permission logic for withdraw operations and access control rules for better clarity and usability.
    • Streamlined validation for page_size to allow values greater than 100.

  • Documentation

    • Updated migration guide to reflect changes and improve user navigation.
    • Added warnings about schema compatibility with versions above v1.1.

@coderabbitai
Copy link

coderabbitai bot commented Sep 19, 2024 •
edited
Loading

Caution

Review failed

The pull request is closed.

Walkthrough

The pull request introduces a version update for the Permify API from "v1.0.7" to "v1.1.0" across multiple documentation and code files. It includes significant changes to the permission logic, particularly for the page_size field, which now allows unlimited values instead of being capped at 100. Additionally, various documentation files have been updated to reflect these changes, including migration guides and API specifications.

Changes

File Path Change Summary
docs/api-reference/apidocs.swagger.json Updated API version from "v1.0.7" to "v1.1.0".
docs/api-reference/openapiv2/apidocs.swagger.json Updated API version from "v1.0.7" to "v1.1.0".
docs/migration/v1.0-v1.1.mdx Introduced changes in data access and permission logic; added scope field and removed page_size limit.
docs/mint.json Minor formatting adjustments and added a "Migration" group in anchors.
docs/modeling-guides/abac/text-object-based-conditions.mdx Simplified permission logic for check_location and updated view permission for organization.
docs/use-cases/abac.mdx Removed warnings about default attribute values and added a new warning regarding schema compatibility with versions above v1.1.
internal/info.go Updated software version from "v1.0.7" to "v1.1.0".
pkg/pb/base/v1/service.pb.validate.go Simplified validation for PageSize, removing the upper limit constraint.
proto/base/v1/openapi.proto Updated API version from "v1.0.7" to "v1.1.0".
proto/base/v1/service.proto Removed upper limit constraint on page_size across multiple message types.

Possibly related issues

Possibly related PRs

🐰 In the meadow, changes bloom,
A version rise dispels the gloom.
Page size now can stretch and play,
Flexibility leads the way!
With docs refined, we hop along,
In the world of code, we all belong! 🌼

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

@tolgaozen tolgaozen merged commit e1442dc into master Sep 19, 2024
@tolgaozen tolgaozen deleted the abac-dsl branch September 19, 2024 13:15
@coderabbitai coderabbitai bot mentioned this pull request Jan 28, 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