Schemas

Download schema

Capabilities

FacetDescription[] · required

Syntax · required

Facet

id

string · required

label

string · required

count

integer · required

FacetDescription

id

string · required

label

string · required

type

string · required

FacetResult

id

string · required

label

string · required

Facet[]

Default: []

HTTPValidationError

ValidationError[]

Kwic

left

string · required

match

string · required

right

string · required

SearchResponse

id

string · required

total

integer · required

@context

string

Default: https://gitlab.gwdg.de/subugoe/searchapi/sandbox/-/raw/main/src/searchapi/context.json

type

string

Default: SearchResponse

SearchResult[]

Default: []

FacetResult[]

Default: []

Service[]

Default: []

SearchResult

id

string · required

label

string · required

Service

id

string · required

type

string · required

Syntax

type

string · required

doc

string · required

exceptions

string[] · required

ValidationError

array · required

msg

string · required

type

string · required

SearchAPI

Schemas

Download schema

Capabilities

FacetDescription[] · required

Syntax · required

Facet

id

string · required

label

string · required

count

integer · required

FacetDescription

id

string · required

label

string · required

type

string · required

FacetResult

id

string · required

label

string · required

Facet[]

Default: []

HTTPValidationError

ValidationError[]

Kwic

left

string · required

match

string · required

right

string · required

SearchResponse

id

string · required

total

integer · required

@context

string

Default: https://gitlab.gwdg.de/subugoe/searchapi/sandbox/-/raw/main/src/searchapi/context.json

type

string

Default: SearchResponse

SearchResult[]

Default: []

FacetResult[]

Default: []

Service[]

Default: []

SearchResult

id

string · required

label

string · required

Service

id

string · required

type

string · required

Syntax

type

string · required

doc

string · required

exceptions

string[] · required

ValidationError

array · required

msg

string · required

type

string · required