DeepMatch deeplinks spec

DeepMatch deeplinks YAML configuration file

Type object
File match **/.deeplinks.yml **/*.deeplinks.yml **/.deeplinks.yaml **/*.deeplinks.yaml
Schema URL https://catalog.lintel.tools/schemas/schemastore/deepmatch-deeplinks-spec/latest.json
Source https://raw.githubusercontent.com/aouledissa/deep-match/main/schemas/deeplinks.schema.json

Validate with Lintel

npx @lintel/lintel check
Type: object

JSON Schema for DeepMatch .deeplinks.yml and .deeplinks.yaml configuration files

Properties

deeplinkSpecs DeeplinkConfig[] required

List of deeplink specifications

Definitions

DeeplinkConfig object

A deeplink configuration object

name string required

Unique identifier for the deeplink spec. Used for generated names and must be unique across all specs in the file.

activity string required

Fully qualified name of the activity eligible to resolve this deeplink

pattern=^[a-zA-Z0-9_.]+$
scheme string[] required

Allowed URI schemes

Examples: ["app"], ["https"], ["app","https"]
minItems=1
description string

Free-form description for the deeplink spec

categories string[]

Intent filter categories

Default:
[
  "DEFAULT"
]
autoVerify boolean

Enables android:autoVerify="true" for app links. If a spec mixes web + custom schemes, generated manifest output is split into separate intent filters so only web schemes are auto-verified.

Default: false
host string[]

Allowed URI hosts/domains. Leave empty or omit for hostless URIs such as app:///profile/123.

Default:
[]
port integer

Optional URI port filter (e.g., staging links on :8080)

pathParams Param[]

Ordered path segments/templates. Order is positional and preserved.

queryParams QueryParam[]

Typed query definitions. Matching is order-agnostic.

fragment string

Required URI fragment (#...). Exposed in generated params when declared. Fragment matching is runtime-only (not manifest-level).

Param object

A path parameter definition

name string required

Path segment label or typed placeholder key

type string

Path parameter value type

Values: "numeric" "alphanumeric" "string"
QueryParam object

A query parameter definition

name string required

Query key name

type string

Query parameter value type used for runtime validation and typed generation

Values: "numeric" "alphanumeric" "string"
required boolean

If true, key must be present to match. Optional typed query params are generated nullable.

Default: false