Lexicon Garden

parts.page.mention.search

Search a mention service for matching results. A single XRPC host can serve multiple mention services, distinguished by the service AT URI.

Repository @page.parts did:plc:de2gzyliybvjo4bfvu4i54de namespace authority
Details · query
Kindquery
Authoritymention.page.parts
Indexed
Compare Edit in builder → Fork →

Query

query · GET

Parameters

query string

limit

integer

Maximum number of results to return

  • minimum: 1
  • maximum: 50
  • default: 20

scope

string

Optional scope identifier to narrow results within a service, as returned by a previous result's subscope.scope field

service

requiredstring · at-uri

AT URI of the parts.page.mention.service record identifying which service to query

Output

application/json

results

requiredarray
  • maxLength: 50
itemsref
Reference

#aspectRatio

object

Properties

height

requiredinteger

width

requiredinteger

#embedInfo

object

Properties

aspectRatio

ref

Aspect ratio of the embed. If provided, takes precedence over width/height for sizing.

Reference

height

integer

Default height of the embed in pixels

  • minimum: 16
  • maximum: 3200

src

requiredstring · uri

Source URL for the iframe embed

width

integer

Default width of the embed in pixels

  • minimum: 16
  • maximum: 3200

#mentionLabel

object

Properties

text

string

#result

object

Properties

description

string

A description for the mentioned entity

embed

ref

Optional embed info for creating an embed block instead of an inline mention

Reference

href

string · uri

Optional web URL for the mentioned entity

icon

string · uri

Optional icon URL for the mentioned entity, displayed next to the mention

labels

array

A set of labels to be rendered with the mentionedEntity

itemsref
Reference

name

requiredstring

Display name for the mentioned entity

subscope

ref

Optional subscope info indicating this result can be scoped into for further searching

Reference

uri

requiredstring

Identifier for the mentioned entity

#subscopeInfo

object

Properties

label

requiredstring

Display label for the scope-down button (e.g. 'Posts', 'Tracks')

  • maxLength: 100

scope

requiredstring

Scope identifier passed back to the service in subsequent search queries

Similar lexicons

semantic match

Lexicons whose schemas describe something close to this one. Check them before publishing a new one that overlaps.

  • parts.page.mention.service

    record

    Declares a mention service. The did is an XRPC service URL that implements parts.page.mention.searchService.