(DAL) Add endpoint to get all symbols

[nick-bisonai]

Description

/dal/symbols endpoints returns all symbols in list of strings
docs will be updated accordingly

Type of change

Please delete options that are not relevant.

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• This change requires a documentation update

Checklist before requesting a review

• I have performed a self-review of my code.
• If it is a core feature, I have added thorough tests.

Deployment

• Should publish npm package
• Should publish Docker image

[coderabbitai]

Walkthrough

Walkthrough

A new function, getSymbols, has been added to the controller.go file in the dal/api package to enable retrieval of symbols from ApiController.configs. This function returns the list of symbols as JSON. Additionally, a new route, /symbols, has been created in the route.go file to map this functionality within the API.

Changes

File	Change Summary
node/pkg/dal/api/controller.go	Added getSymbols function to retrieve symbols as JSON from ApiController.configs.
node/pkg/dal/api/route.go	Added new route /symbols in the api group under /dal.

Poem

In the realm where code does dwell,
A new path carved to tell,
Symbols dance in JSON's grace,
getSymbols brings them to the interface.
Routes align in fiber's care,
/symbols now leads us there.
🎉✨🐰

---

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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between cccac8e and 896127f.

Files selected for processing (2)

• node/pkg/dal/api/controller.go (1 hunks)
• node/pkg/dal/api/route.go (1 hunks)

Additional comments not posted (2)

node/pkg/dal/api/route.go (1)

11-11: The route addition is correct.

The route /symbols is correctly mapped to the getSymbols function.

node/pkg/dal/api/controller.go (1)

213-219: The method implementation is correct.

The getSymbols method correctly retrieves the list of symbols from ApiController.configs and returns it as JSON.

[Intizar-T]

lgtm!