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

Use the same property name for the query term in search requests #2214

Merged
merged 2 commits into from
Jun 14, 2023

Conversation

MatteoPologruto
Copy link
Contributor

@MatteoPologruto MatteoPologruto commented Jun 14, 2023

Please check if the PR fulfills these requirements

See how to contribute

  • The PR has no duplicates (please search among the Pull Requests
    before creating one)
  • The PR follows
    our contributing guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)
  • UPGRADING.md has been updated with a migration guide (for breaking changes)
  • configuration.schema.json updated if new parameters are added.

What kind of change does this PR introduce?

gRPC enhancement

What is the current behavior?

Search requests use different properties for the query term:

message LibrarySearchRequest {
  // The search query.
  string query = 2;
}
message PlatformSearchRequest {
  // Keywords for the search.
  string search_args = 2;
}
message BoardSearchRequest {
  // The search query to filter the board list by.
  string search_args = 2;
}

What is the new behavior?

The query property in LibSearchRequest has been deprecated. search_args should be used in its place.

Does this PR introduce a breaking change, and is titled accordingly?

No

@cmaglie cmaglie added this to the Arduino CLI 1.0 milestone Jun 14, 2023
@codecov
Copy link

codecov bot commented Jun 14, 2023

Codecov Report

Patch coverage: 100.00% and project coverage change: -0.06 ⚠️

Comparison is base (5725c02) 62.98% compared to head (6360f1e) 62.93%.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #2214      +/-   ##
==========================================
- Coverage   62.98%   62.93%   -0.06%     
==========================================
  Files         218      218              
  Lines       19466    19469       +3     
==========================================
- Hits        12261    12252       -9     
- Misses       6122     6131       +9     
- Partials     1083     1086       +3     
Flag Coverage Δ
unit 62.93% <100.00%> (-0.06%) ⬇️

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

Impacted Files Coverage Δ
commands/lib/search.go 96.66% <100.00%> (+0.11%) ⬆️
internal/cli/arguments/completion.go 87.67% <100.00%> (ø)
internal/cli/lib/args.go 84.21% <100.00%> (ø)
internal/cli/lib/search.go 60.80% <100.00%> (ø)

... and 1 file with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

@MatteoPologruto MatteoPologruto merged commit c6afede into arduino:master Jun 14, 2023
@MatteoPologruto MatteoPologruto deleted the query-term-name branch June 14, 2023 16:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: gRPC Related to the gRPC interface type: enhancement Proposed improvement
Projects
None yet
2 participants