Skip to content

ignored property of Search API #2145

Open
@tomcrane

Description

@tomcrane

These changes would be a breaking change for v3 of Search, but they allows for static implementations

A Server MUST state that it has ignored parameters defined in the Search spec, but only SHOULD state that it has ignored other parameters.

e.g.,
MUST
?user=xxx => "ignored": ["user"]
?user=xxx&color=blue => "ignored": ["user"]

SHOULD
?user=xxx&color=blue => "ignored": ["user", "color"]

A Server MAY state that it has ignored parameters defined in this specification, even if they were not supplied

(no query string at all...!)
GET /search/my-video-transcripts/en => "ignored": ["q", "user", "date", "motivation"]

This could be served statically, and doesn't have to dynamically generate ignored for spec or any other parameters.

In the current spec this doesn't make much sense but it opens the way for static sets of search results to supply captions as discussed in #762 (comment), or potentially authed search services.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions