MintPlayer.Spark.OpenSearchDescription
11.0.0
dotnet add package MintPlayer.Spark.OpenSearchDescription --version 11.0.0
NuGet\Install-Package MintPlayer.Spark.OpenSearchDescription -Version 11.0.0
<PackageReference Include="MintPlayer.Spark.OpenSearchDescription" Version="11.0.0" />
<PackageVersion Include="MintPlayer.Spark.OpenSearchDescription" Version="11.0.0" />
<PackageReference Include="MintPlayer.Spark.OpenSearchDescription" />
paket add MintPlayer.Spark.OpenSearchDescription --version 11.0.0
#r "nuget: MintPlayer.Spark.OpenSearchDescription, 11.0.0"
#:package MintPlayer.Spark.OpenSearchDescription@11.0.0
#addin nuget:?package=MintPlayer.Spark.OpenSearchDescription&version=11.0.0
#tool nuget:?package=MintPlayer.Spark.OpenSearchDescription&version=11.0.0
MintPlayer.Spark.OpenSearchDescription
Makes a Spark application a search engine a browser can add ("Add search engine", typing in the address bar), through MintPlayer.AspNetCore.OpenSearch. Suggestions and searches go through MintPlayer.Spark.Search, so they show only what the visitor may read.
builder.Services.AddSpark(builder.Configuration, spark =>
{
spark.AddSearch(); // optional: added when missing
spark.AddOpenSearchDescription(o => o.ShortName = "MintPlayer");
});
provideSpark(withOpenSearchDescription({ title: 'MintPlayer' })) // adds <link rel="search">
| Endpoint | Answers |
|---|---|
GET /opensearch.xml |
The description document (application/opensearchdescription+xml), absolute URLs. |
GET /spark/opensearch/suggest?q= |
[q, [labels]]: Spark search's unambiguous labels. |
GET /spark/opensearch/search?q= |
302 to the one object the term names (a picked label, or a term only one visible object matches), else to /search?q=. |
Options
| Option | Default | |
|---|---|---|
ShortName |
entry assembly name | At most 16 characters; longer is cut. |
Description |
Search {ShortName} |
|
ImageUrl / ImageType / ImageSize |
/favicon.ico, image/x-icon, 16 |
ImageUrl = null advertises no icon. |
SingleHit |
Item |
SearchPage always lands on the search page. |
Path, SuggestPath, SearchPath |
as above |
The search page is SparkSearchOptions.SearchPagePath (/search). Suggestions and searches count against the same
per-address budget as /spark/search/*; over it, suggestions are empty and a search lands on the search page.
AddOpenSearch registers MVC with an XML output formatter and sets RespectBrowserAcceptHeader. The formatter only
writes the description document, so every other response still negotiates to JSON.
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net11.0 is compatible. |
-
net11.0
- MintPlayer.AspNetCore.OpenSearch (>= 11.0.1)
- MintPlayer.Spark.Search (>= 11.0.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
| Version | Downloads | Last Updated |
|---|---|---|
| 11.0.0 | 44 | 11/18/2026 |