Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Jun 20, 2025

This PR implements the requested GitHub profile management endpoints for admin users as specified in the issue.

Added Endpoints

  • GET /api/github/profiles - Paginated list of GitHub profiles ordered by creation date (desc)
  • GET /api/github/chats - Paginated list of GitHub profile bot chats ordered by usage (messages count desc), then by creation date (desc)
  • GET /api/github/processing-jobs - Complete list of GitHub processing jobs ordered by creation date (desc) without pagination
  • DELETE /api/github/processing-jobs/{username} - Delete a GitHub processing job by username

Implementation Details

Files Added

  • GithubController.cs - Main API controller with admin-only access
  • GithubProfileDto.cs - Data transfer object for GitHub profiles
  • GithubProfileBotChatDto.cs - Data transfer object for bot chats
  • GithubProfileProcessingJobDto.cs - Data transfer object for processing jobs

Key Features

  • Admin Authorization: All endpoints require admin role ([HasAnyRole(Role.Admin)])
  • Pagination: Uses existing PageModel and AsPaginatedAsync patterns for profiles and chats endpoints
  • Proper Ordering: Implements exact ordering requirements from the issue
  • Error Handling: Returns appropriate HTTP status codes (NotFound for missing processing jobs)
  • Consistent Patterns: Follows existing codebase conventions and patterns from InterviewsController

Example Usage

GET /api/github/profiles?page=1&pageSize=20
GET /api/github/chats?page=1&pageSize=10  
GET /api/github/processing-jobs
DELETE /api/github/processing-jobs/username123

The implementation uses direct database access following existing patterns and maintains consistency with the current codebase architecture.

Fixes #126.


💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.

Co-authored-by: maximgorbatyuk <13348685+maximgorbatyuk@users.noreply.github.com>
Copilot AI changed the title [WIP] Added endpoints for Github Profile entities Add GitHub profile management endpoints Jun 20, 2025
Copilot AI requested a review from maximgorbatyuk June 20, 2025 13:02
Copilot finished work on behalf of maximgorbatyuk June 20, 2025 13:02
[ApiController]
[Route("api/github")]
[HasAnyRole(Role.Admin)]
public class GithubController : ControllerBase
Copy link
Member

Choose a reason for hiding this comment

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

Looks nice, but it is not enough. Please create Handlers with commands. Also, please create special ...QUeryParams classes for endpoints with pagination. I am going to introduce searching feature in the future, so separate classes that inherit PageModel, will be required

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I've refactored the implementation to use the Handler pattern with separate QueryParams classes as requested. Each endpoint now has its own handler implementing IRequestHandler<TRequest, TResult> and QueryParams classes that inherit from PageModel for future search functionality extensibility. The structure now matches the existing patterns in the codebase like CompaniesController. Changes in commit ee35bc5.

…sses

Co-authored-by: maximgorbatyuk <13348685+maximgorbatyuk@users.noreply.github.com>
Copilot AI requested a review from maximgorbatyuk June 20, 2025 13:22
Copilot finished work on behalf of maximgorbatyuk June 20, 2025 13:22
@maximgorbatyuk maximgorbatyuk marked this pull request as ready for review June 20, 2025 17:17
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jun 20, 2025

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


🪧 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? Join our Discord community 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 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.

@maximgorbatyuk maximgorbatyuk merged commit 0bddf8d into main Jun 21, 2025
3 checks passed
@maximgorbatyuk maximgorbatyuk deleted the copilot/fix-126 branch June 21, 2025 07:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Added endpoints for Github Profile entities

2 participants