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

[BREAKING- REFACTOR] argilla-server: remove metadata filter query param #5156

Conversation

frascuchon
Copy link
Member

@frascuchon frascuchon commented Jul 4, 2024

Description

Note

This PR must be merged after #5153

This PR removes support for filtering using metadata as a query param:

  • This filter is not available anymore for list endpoints
  • The metadata filter can be defined as part of the request body for search filters.

Type of change

  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Refactor (change restructuring the codebase without changing functionality)

How Has This Been Tested

Checklist

  • I added relevant documentation
  • follows the style guidelines of this project
  • I did a self-review of my code
  • I made corresponding changes to the documentation
  • I confirm My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • I have added relevant notes to the CHANGELOG.md file (See https://keepachangelog.com/)

@frascuchon frascuchon requested a review from jfcalvo July 4, 2024 10:05
Copy link

codecov bot commented Jul 4, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.93%. Comparing base (fca0c82) to head (d0f158e).

Additional details and impacted files
@@                                       Coverage Diff                                        @@
##           refactor/argilla-server/remove-list-current-records-endpoint    #5156      +/-   ##
================================================================================================
- Coverage                                                         91.99%   91.93%   -0.06%     
================================================================================================
  Files                                                               137      137              
  Lines                                                              5896     5817      -79     
================================================================================================
- Hits                                                               5424     5348      -76     
+ Misses                                                              472      469       -3     
Flag Coverage Δ
argilla-server 91.93% <100.00%> (-0.06%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@jfcalvo
Copy link
Member

jfcalvo commented Jul 4, 2024

Looks ok to me (not sure if a line on CHANGELOG.md could be useful).

Base automatically changed from refactor/argilla-server/remove-list-current-records-endpoint to refactor/cleaning-list-records-endpoints July 4, 2024 12:59
@frascuchon
Copy link
Member Author

Looks ok to me (not sure if a line on CHANGELOG.md could be useful).

Yes. I forget to include it. Done.

@frascuchon frascuchon merged commit 89f9bde into refactor/cleaning-list-records-endpoints Jul 4, 2024
2 checks passed
@frascuchon frascuchon deleted the refactor/argilla-server/remove-metadata-filter-query-param branch July 4, 2024 13:03
frascuchon added a commit that referenced this pull request Jul 4, 2024
…upport (#5163)

# Description
<!-- Please include a summary of the changes and the related issue.
Please also include relevant motivation and context. List any
dependencies that are required for this change. -->

> [!NOTE]
> This PR must be merged after
#5156

This PR removes support for filtering records with response_status query
param:

- This filter is removed for listing records endpoints
- The response status filter is available for search endpoints using the
filter request body.

**Type of change**
<!-- Please delete options that are not relevant. Remember to title the
PR according to the type of change -->

- Breaking change (fix or feature that would cause existing
functionality to not work as expected)
- Refactor (change restructuring the codebase without changing
functionality)

**How Has This Been Tested**
<!-- Please add some reference about how your feature has been tested.
-->

**Checklist**
<!-- Please go over the list and make sure you've taken everything into
account -->

- I added relevant documentation
- I followed the style guidelines of this project
- I did a self-review of my code
- I made corresponding changes to the documentation
- I confirm My changes generate no new warnings
- I have added tests that prove my fix is effective or that my feature
works
- I have added relevant notes to the CHANGELOG.md file (See
https://keepachangelog.com/)

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: José Francisco Calvo <[email protected]>
frascuchon added a commit that referenced this pull request Jul 15, 2024
# Pull Request Template
<!-- Please include a summary of the changes and the related issue.
Please also include relevant motivation and context. List any
dependencies that are required for this change. -->

This PR merges all the approved PRs related to cleaning list and search
records endpoints

- #5153
- #5156
- #5163
- #5166

**Type of change**
<!-- Please delete options that are not relevant. Remember to title the
PR according to the type of change -->

- 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)
- Refactor (change restructuring the codebase without changing
functionality)
- Improvement (change adding some improvement to an existing
functionality)
- Documentation update

**How Has This Been Tested**
<!-- Please add some reference about how your feature has been tested.
-->

**Checklist**
<!-- Please go over the list and make sure you've taken everything into
account -->

- I added relevant documentation
- I followed the style guidelines of this project
- I did a self-review of my code
- I made corresponding changes to the documentation
- I confirm My changes generate no new warnings
- I have added tests that prove my fix is effective or that my feature
works
- I have added relevant notes to the CHANGELOG.md file (See
https://keepachangelog.com/)

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: José Francisco Calvo <[email protected]>
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