385 discourse metric apis

[Behzad-rabiei]

Summary by CodeRabbit

• New Features

  • Added support for the Discourse platform, enabling property management alongside Discord.
  • Introduced new schema fields (allCategories, include, exclude) for enhanced category selection in API requests.
  • Implemented services for fetching categories and handling properties specific to Discourse.

• Bug Fixes

  • Improved validation logic for heatmap chart requests, allowing for more nuanced category inclusion/exclusion.

• Documentation

  • Updated descriptions and examples in the API documentation to reflect new functionalities and schema changes.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The changes introduced in this pull request enhance the functionality of the application by adding support for the Discourse platform alongside the existing Discord functionality. Key modifications include the addition of new properties in the API schema, the introduction of services for managing categories, and updates to validation logic to accommodate Discourse-specific requirements. These changes collectively improve the controller's ability to handle properties and provide more granular control over category selection in API requests.

Changes

Files	Change Summary
src/controllers/platform.controller.ts	Added handling for Discourse in getProperties function, invoking getPropertyHandler from discourseService.
src/docs/discourse.doc.yml	Introduced new fields allCategories, include, and exclude to the schema, enhancing category selection control.
src/docs/platform.doc.yml	Made formatting changes, updated descriptions for parameters related to properties for Discourse.
src/services/discord/core.service.ts	Removed JSDoc comment block for getPropertyHandler function, leaving the function intact.
src/services/discourse/category.service.ts	Created a service for fetching categories from Neo4j, implementing getCategoriesByEndPoint function with filters and pagination.
src/services/discourse/core.service.ts	Introduced a service module for handling Discourse requests, implementing getPropertyHandler function.
src/services/discourse/heatmap.service.ts	Updated getHeatmapChart function to include new filtering capabilities based on categories.
src/services/discourse/index.ts	Added categoryService and coreService to the default export for better service management.
src/validations/discourse.validation.ts	Added validation rules for heatmapChart object, incorporating new properties for category filtering.
src/validations/platform.validation.ts	Introduced discourseProperties function for validating Discourse platform requests, enhancing dynamic property handling.

Possibly related PRs

• feat: add discourse support for framentation and decentralisation met… #386: Introduces constants related to supported Neo4j platforms, including Discourse, relevant to the enhancements made in this PR.
• feat: add discourse/heatmap APIs #387: Adds new APIs for Discourse heatmap and line graph functionalities, directly relating to the improvements in handling properties for the Discourse platform.

Poem

🐇 In the meadow where changes bloom,
Discourse joins Discord, dispelling gloom.
New properties sprout, like flowers in spring,
With validation and services, oh what joy they bring!
Hopping through code, we celebrate the cheer,
For every new feature, we hold dear! 🌼

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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.