Skip to content

Latest commit

 

History

History
189 lines (103 loc) · 5.22 KB

index.md

File metadata and controls

189 lines (103 loc) · 5.22 KB

Index Schema

https://ns.adobe.com/helix/shared/index
Abstract Extensible Status Identifiable Custom Properties Additional Properties Access Restrictions Defined In
Can be instantiated No Unknown status No Forbidden Allowed none index.schema.json

Index Type

object (Index)

Index Properties

Property Type Required Nullable Defined by
source string Optional cannot be null Index
fetch string Optional cannot be null Index
target string Optional cannot be null Index
properties object Required cannot be null Index
queries object Optional cannot be null Index
include array Optional cannot be null Index
exclude array Optional cannot be null Index

source

The source representation to be used by the indexer to extract values

source

  • is optional

  • Type: string (Source)

  • cannot be null

  • defined in: Index

source Type

string (Source)

source Constraints

enum: the value of this property must be equal to one of the following values:

Value Explanation
"html"
"markdown"

fetch

The source document to retrieve values from. Known variables in the URI Template are: repo, ref, owner, path

fetch

  • is optional

  • Type: string

  • cannot be null

  • defined in: Index

fetch Type

string

fetch Constraints

URI Template: the string must be a URI template, according to RFC 6570

target

The data sink to store the extracted data in. This can be an Excel or Google spreadsheet, an Azure Index or Algolia index

target

  • is optional

  • Type: string

  • cannot be null

  • defined in: Index

target Type

string

target Constraints

URI reference: the string must be a URI reference, according to RFC 3986

properties

The properties to add to the index

properties

properties Type

object (Properties)

queries

Named queries that can be executed against this index

queries

  • is optional

  • Type: object (Queries)

  • cannot be null

  • defined in: Index

queries Type

object (Queries)

include

Glob patterns for paths where this index is used.

include

  • is optional

  • Type: string[]

  • cannot be null

  • defined in: Index

include Type

string[]

include Examples

/blog/**

/en/publish/*/*/*/*

exclude

Glob patterns for paths where this index must not be used.

exclude

  • is optional

  • Type: string[]

  • cannot be null

  • defined in: Index

exclude Type

string[]

exclude Examples

/drafts/**