Skip to content
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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Query parameter support for entity store query API #3383

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

albinsuresh
Copy link
Contributor

@albinsuresh albinsuresh commented Feb 5, 2025

Proposed changes

  • Add query parameter support for the query API
  • Supported parameters:
    • root
    • parent
    • type
    • depth
  • Documentation

Types of changes

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Improvement (general improvements like code refactoring that doesn't explicitly fix a bug or add any new functionality)
  • Documentation Update (if none of the other choices apply)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

Paste Link to the issue


Checklist

  • I have read the CONTRIBUTING doc
  • I have signed the CLA (in all commits with git commit -s)
  • I ran cargo fmt as mentioned in CODING_GUIDELINES
  • I used cargo clippy as mentioned in CODING_GUIDELINES
  • I have added tests that prove my fix is effective or that my feature works
  • I have added necessary documentation (if appropriate)

Further comments

Copy link

codecov bot commented Feb 6, 2025

Codecov Report

Attention: Patch coverage is 93.26923% with 14 lines in your changes missing coverage. Please review.

Files with missing lines Patch % Lines
...s/core/tedge_agent/src/http_server/entity_store.rs 87.01% 4 Missing and 6 partials ⚠️
...ates/core/tedge_agent/src/entity_manager/server.rs 0.00% 2 Missing ⚠️
crates/core/tedge_api/src/entity_store.rs 98.44% 2 Missing ⚠️
Additional details and impacted files

📢 Thoughts on this report? Let us know!

Copy link
Contributor

github-actions bot commented Feb 6, 2025

Robot Results

✅ Passed ❌ Failed ⏭️ Skipped Total Pass % ⏱️ Duration
575 0 3 575 100 1h35m13.788419s

@albinsuresh albinsuresh marked this pull request as ready for review February 6, 2025 08:05
@didier-wenzek
Copy link
Contributor

I don't see a depth parameter as useful, and I would not spent time implementing support for that.

In practice the entity tree will be mostly never deep.

Copy link
Contributor

@didier-wenzek didier-wenzek left a comment

Choose a reason for hiding this comment

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

I will be happy to approve, once docs added.

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.

2 participants