8000 fix(api): add note about switching to the New Public API by RaHehl · Pull Request #531 · uilibs/uiprotect · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

fix(api): add note about switching to the New Public API #531

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
Jul 8, 2025
Merged

fix(api): add note about switching to the New Public API #531

merged 1 commit into from
Jul 8, 2025
+2 −0

Conversation

RaHehl
Copy link
Collaborator
@RaHehl RaHehl commented Jul 8, 2025 •
edited by coderabbitai bot
Loading

Description of change

dummy change to trigger a release for #530

Pull-Request Checklist

  • Code is up-to-date with the main branch
  • This pull request follows the contributing guidelines.
  • This pull request links relevant issues as Fixes #0000
  • There are new or updated unit tests validating the change
  • Documentation has been updated to reflect this change
  • The new commits follow conventions outlined in the conventional commit spec, such as "fix(api): prevent racing of requests".
  • If pre-commit.ci is failing, try pre-commit run -a for further information.
  • If CI / test is failing, try poetry run pytest for further information.

Summary by CodeRabbit

  • Documentation
    • Added a note in the README about switching from the Protect Private API to the new Public API under planned tasks.

@coderabbitai coderabbitai
Copy link
Contributor
coderabbitai bot commented Jul 8, 2025 •
edited
Loading

Walkthrough

A new bullet point titled "Switching from Protect Private API to the New Public API" was added under the "TODO / Planned / Not Implemented" section in the README.md file. No other content or context was changed.

Changes

File Change Summary
README.md Added a new TODO bullet about switching from Protect Private API to the New Public API.

Poem

🐇
A note was added, crisp and neat,
In README’s list of tasks to meet.
From private paths to public view,
A future switch is now in queue.
With every line, our plans take flight—
More to come, the future’s bright!

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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

coderabbitai[bot]
coderabbitai bot reviewed Jul 8, 2025
View reviewed changes
Copy link
Contributor
@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
README.md (1)

201-202: Markdown bullet & wording need adjustment

The new line is intended to be a list item, but without a leading -/* it renders as plain text.
Minor grammar tweaks improve clarity.

- Switching from Protect Private API to the New Public API
+ - Switch from the Protect Private API to the new Public API
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between e646655 and 04efc19.

📒 Files selected for processing (1)
  • README.md (1 hunks)
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings 
Learnt from: bdraco
PR: uilibs/uiprotect#66
File: src/uiprotect/data/types.py:129-129
Timestamp: 2024-06-15T18:40:14.736Z
Learning: The TODO comment in the `_bootstrap_model_types` method within `src/uiprotect/data/types.py`, mentioning "legacyUFV, display", is pre-existing and was not introduced or modified in PR #66.
README.md (1) 
Learnt from: bdraco
PR: uilibs/uiprotect#66
File: src/uiprotect/data/types.py:129-129
Timestamp: 2024-06-15T18:40:14.736Z
Learning: The TODO comment in the `_bootstrap_model_types` method within `src/uiprotect/data/types.py`, mentioning "legacyUFV, display", is pre-existing and was not introduced or modified in PR #66.
🪛 LanguageTool
README.md

[grammar] ~201-~201: Use articles correctly.
Context: ...anned / Not Implemented Switching from Protect Private API to the New Public API Gene...

(QB_NEW_EN_OTHER_ERROR_IDS_000004)

[grammar] ~201-~201: Use proper spacing conventions.
Context: ...rotect Private API to the New Public API Generally any feature missing from the l...

(QB_NEW_EN_OTHER_ERROR_IDS_000007)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)
  • GitHub Check: test (3.12, ubuntu-latest, 2)
  • GitHub Check: test (3.13, ubuntu-latest, 2)
  • GitHub Check: test (3.10, ubuntu-latest, 2)
  • GitHub Check: test (3.11, ubuntu-latest, 2)

@codecov Codecov
Copy link
codecov bot commented Jul 8, 2025 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@RaHehl RaHehl merged commit eb478d2 into uilibs:main Jul 8, 2025
9 of 10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

Assignees
No one assigned
47EC
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@RaHehl
0