Skip to content

feat: enhance get community api to respond all communities#429

Merged
cyri113 merged 1 commit intomainfrom
427-see-connected-communities
Feb 12, 2025
Merged

feat: enhance get community api to respond all communities#429
cyri113 merged 1 commit intomainfrom
427-see-connected-communities

Conversation

@cyri113
Copy link
Contributor

@cyri113 cyri113 commented Feb 12, 2025

Summary by CodeRabbit

  • New Features

    • The communities endpoint now supports a new query option that lets users retrieve all available communities instead of only those filtered by access.
    • Each community now returns an indicator flag showing whether the user has access.
  • Documentation

    • The API documentation has been updated to reflect the new query option, response formats, and consistent response status information.

@coderabbitai
Copy link

coderabbitai bot commented Feb 12, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

This pull request updates the community endpoint logic and associated documentation. The primary changes are in the getCommunities method within the community controller, where the function now checks for an includeAllCommunities query parameter to determine whether to filter communities by user access. The modifications include reordering imports and adding a new import for PlatformNames. Additionally, the API documentation and schema files have been updated for consistency (e.g., switching to single quotes for response codes, adding the userHasAccess property), and the validation for the endpoint now includes a new boolean flag with a default value.

Changes

File(s) Change Summary
src/controllers/community.controller.ts Updated the getCommunities function to conditionally retrieve all or user-specific communities based on the new includeAllCommunities query parameter; reorders import statements and adds the PlatformNames import.
src/docs/community.doc.yml
src/docs/schemes.doc.yml
Updated API documentation to use single quotes for response codes; added new query parameter includeAllCommunities in the GET endpoint and introduced a new boolean property userHasAccess in the Community schema.
src/validations/community.validation.ts Added the includeAllCommunities boolean property (defaulting to false) in the getCommunities validation schema; adjusted the import order with respect to PlatformNames.

Sequence Diagram(s)

sequenceDiagram
  participant Req as Request
  participant Ctrl as CommunityController
  participant DB as Database

  Req->>Ctrl: GET /api/v1/communities?includeAllCommunities=?
  alt includeAllCommunities present
      Ctrl->>DB: Fetch all communities
      DB-->>Ctrl: Return all communities data
      Ctrl->>Ctrl: Map results to determine user roles<br/>and set userHasAccess based on roles
  else
      Ctrl->>DB: Fetch communities using filter criteria
      DB-->>Ctrl: Return filtered communities data
      Ctrl->>DB: Fetch user-specific communities
      DB-->>Ctrl: Return user communities data
      Ctrl->>Ctrl: Filter by community IDs<br/>and mark userHasAccess as true
  end
  Ctrl->>Req: Send communities response with appropriate HTTP status
Loading

Possibly related PRs

Poem

I'm a rabbit hopping through lines of code,
With communities vast on each winding road.
Filtering paths with a twitch of my ear,
New flags and schemas now crystal clear.
Hop along with me, joyful and bright,
For in these changes, our code takes flight! 🐇


📜 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 4b77ab1 and 235e1f1.

📒 Files selected for processing (4)
  • src/controllers/community.controller.ts (3 hunks)
  • src/docs/community.doc.yml (8 hunks)
  • src/docs/schemes.doc.yml (1 hunks)
  • src/validations/community.validation.ts (2 hunks)
✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

@cyri113 cyri113 merged commit 2e67192 into main Feb 12, 2025
13 checks passed
@Behzad-rabiei Behzad-rabiei linked an issue Feb 16, 2025 that may be closed by this pull request
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.

See connected communities

2 participants