Skip to content

Update search3.md#246

Draft
lachlan-00 wants to merge 6 commits into
opensubsonic:mainfrom
lachlan-00:searchclarification
Draft

Update search3.md#246
lachlan-00 wants to merge 6 commits into
opensubsonic:mainfrom
lachlan-00:searchclarification

Conversation

@lachlan-00

Copy link
Copy Markdown
Member

rules for query parameters as discussed in #195

rules for `query` parameters
Copilot AI review requested due to automatic review settings June 5, 2026 05:33
@netlify

netlify Bot commented Jun 5, 2026

Copy link
Copy Markdown

Deploy Preview for opensubsonic ready!

Name Link
🔨 Latest commit fcca15d
🔍 Latest deploy log https://app.netlify.com/projects/opensubsonic/deploys/6a26594895abb300087ce502
😎 Deploy Preview https://deploy-preview-246--opensubsonic.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

This PR updates the search3 endpoint documentation to clarify OpenSubsonic server requirements for how the query parameter is parsed and matched, based on the discussion in #195.

Changes:

  • Adds a new OpenSubsonic warning block specifying required query parsing/matching rules (per-word matching, grouping, and matching behavior).
  • Documents grouping behavior via + or quotes and how grouped vs ungrouped words should match.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread content/en/docs/Endpoints/search3.md Outdated
Comment thread content/en/docs/Endpoints/search3.md Outdated
Comment thread content/en/docs/Endpoints/search3.md Outdated
@Tolriq

Tolriq commented Jun 5, 2026

Copy link
Copy Markdown
Member

Written like that you prevent servers to use fuzzy search or any improvement to their search algo.

lachlan-00 added a commit to ampache/ampache that referenced this pull request Jun 5, 2026
@lachlan-00

Copy link
Copy Markdown
Member Author

I've implemented the first round, i'll put more information around fuzzy things as well after.

right now i'm also including search* "search term"* and a few others so will need to extend this

@lachlan-00 lachlan-00 marked this pull request as draft June 5, 2026 07:39
@deluan

deluan commented Jun 5, 2026

Copy link
Copy Markdown
Member

I don't think I agree with forcing this over all server implementations, specially defining which fields to search on.

@lachlan-00

Copy link
Copy Markdown
Member Author

I've added "by default" in the rules and rewritten it a bit looser. This is all based on demo.subsonic.org's behaviour as the "subsonic way".

I think from here there also needs to be a new search endpoint that allows heavier customisation, rules and objects to match which i've raised before.

There needs to be definition of what the standard is otherwise search3 means anything you want which isn't helpful if we're all going to implement the same thing.

I don't care what the standard actually is but we need to do the same things and a clarification of some kind will set that requirement.

@lachlan-00

Copy link
Copy Markdown
Member Author

Regarding search fields i think there needs to be the subsonic way then the wild way.

A new parameter like anywhere would let you open up the query past the defaults

| `anywhere` | No | **Yes** | 0 | 0,1 Search all available fields instead of just the name/title |

Alternatively MusicBrainz allows query prefixing which is also a possible alternative but i like it less as it's a significant change to implement

https://musicbrainz.org/ws/2/release?query=artist:${artistName}&fmt=json

What i'm trying to push for is some kind of consensus on what to do so it's clear.

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.

4 participants