ludeeus/aiogithubapiPublic

NotificationsYou must be signed in to change notification settings
Fork18
Star29

Add more attributes to models#407

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.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Jump to bottom

Merged

ludeeus merged 1 commit intomainfrommore-headers

May 26, 2025

Merged

Add more attributes to models#407

ludeeus merged 1 commit intomainfrommore-headers

May 26, 2025

Conversation

Copy link

Owner

ludeeus commentedMay 26, 2025

Proposed change

Extend the models with missing attributes.

Type of change

Dependency upgrade
Bugfix (non-breaking change which fixes an issue)
New feature (which adds functionalit)
Breaking change (fix/feature causing existing functionality to break)
Code quality improvements to existing code or addition of tests

Additional information

This PR fixes or closes issue: fixes #
This PR is related to issue:

Checklist

The code change is tested and works locally.
Local tests pass.
There is no commented out code in this PR.
The code has been formatted using Black (make lint)
Tests have been added to verify that the new code works.

Add more attributes to models

26b3d4d

CopilotAI review requested due to automatic review settings

May 26, 2025 06:44

CopilotAI reviewed

May 26, 2025

View reviewed changes

Copy link

Contributor

CopilotAI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR extends the existing models by adding missing attributes to improve the representation of GitHub user and response header data.

Added "user_view_type" to the GitHubBaseUserModel in user.py.
Added "accept_ranges" and "x_accepted_github_permissions" to the GitHubResponseHeadersModel in response.py.

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.

File	Description
aiogithubapi/models/user.py	Added a new attribute "user_view_type" to extend user details.
aiogithubapi/models/response.py	Added new attributes "accept_ranges" and "x_accepted_github_permissions" to enhance response header info.

aiogithubapi/models/user.pyShow resolvedHide resolved

aiogithubapi/models/response.pyShow resolvedHide resolved

Copy link

coderabbitaibot commentedMay 26, 2025

📝 Walkthrough

Walkthrough

Two new optional string fields were added to theGitHubResponseHeadersModel to capture additional HTTP response headers. Additionally, an optional string attribute was introduced to theGitHubBaseUserModel to represent user view type. No other logic or control flow was modified.

Changes

File(s)	Change Summary
aiogithubapi/models/response.py	Added optional fields`accept_ranges` and`x_accepted_github_permissions` to`GitHubResponseHeadersModel`.
aiogithubapi/models/user.py	Added optional attribute`user_view_type` to`GitHubBaseUserModel`.

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between9fdc30f and26b3d4d.

📒 Files selected for processing (2)

aiogithubapi/models/response.py (2 hunks)
aiogithubapi/models/user.py (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (1)

GitHub Check: Coverage

🔇 Additional comments (3)

aiogithubapi/models/user.py (1)
30-30:Add optionaluser_view_type attribute
This non-breaking addition follows the existing field pattern and will allow the model to capture the user view type. To ensure it’s correctly populated from API responses, please add or update unit tests covering this new attribute.
aiogithubapi/models/response.py (2)
18-18:Addaccept_ranges header attribute
This new optional field maps to theAccept-Ranges HTTP response header and is consistent with the model’s existing properties. Please verify that the header name is slugified correctly and add tests to confirm parsing.
39-39:Addx_accepted_github_permissions header attribute
This field captures theX-Accepted-Github-Permissions header. Ensure the attribute name aligns with the actual header slugification and include tests to validate its presence.

✨ 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 withCodeRabbit:

‼️IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

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 oursupport 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 togenerate 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 theconfiguration 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