schema
stringclasses 471
values | key
stringlengths 0
203
| description
stringlengths 0
4.37k
| object
stringlengths 2
322k
|
|---|---|---|---|
ifstate.conf.schema.json
|
msglvl
|
driver message flags by number
|
{"type": "integer"}
|
ifstate.conf.schema.json
|
msglvl
|
driver message flags by name
|
{"type": "array", "items": [{"type": "string", "enum": ["drv", "probe", "link", "timer", "ifdown", "ifup", "rx_err", "tx_err", "tx_queued", "intr", "tx_done", "rx_status", "pktdata", "hw", "wol"]}, {}]}
|
ifstate.conf.schema.json
|
items
|
flag name
|
{"type": "string", "enum": ["drv", "probe", "link", "timer", "ifdown", "ifup", "rx_err", "tx_err", "tx_queued", "intr", "tx_done", "rx_status", "pktdata", "hw", "wol"]}
|
ifstate.conf.schema.json
|
items
|
enable flag
|
{}
|
ifstate.conf.schema.json
|
channels
|
number of channels
|
{"type": "object", "additionalProperties": false, "properties": {"rx": {"type": "integer"}, "tx": {"type": "integer"}, "other": {"type": "integer"}, "combined": {"type": "integer"}}}
|
ifstate.conf.schema.json
|
rx
|
number of channels with only receive queues
|
{"type": "integer"}
|
ifstate.conf.schema.json
|
tx
|
number of channels with only transmit queues
|
{"type": "integer"}
|
ifstate.conf.schema.json
|
other
|
number of channels used only for other purposes
|
{"type": "integer"}
|
ifstate.conf.schema.json
|
combined
|
number of multi-purpose channels
|
{"type": "integer"}
|
ifstate.conf.schema.json
|
eee
|
Energy-Efficient Ethernet (according to the IEEE 802.3az specifications)
|
{"type": "object", "additionalProperties": false, "properties": {"eee": {}, "tx-lpi": {}, "advertise": {"type": "integer"}, "tx-timer": {"type": "integer"}}}
|
ifstate.conf.schema.json
|
eee
|
enable EEE support
|
{}
|
ifstate.conf.schema.json
|
tx-lpi
|
assert Tx LPI
|
{}
|
ifstate.conf.schema.json
|
advertise
|
sets the speed for which EEE should be enabled (see also `change.advertise`)
|
{"type": "integer"}
|
ifstate.conf.schema.json
|
tx-timer
|
amount of idle time prior asserting Tx LPI (in microseconds)
|
{"type": "integer"}
|
ifstate.conf.schema.json
|
phy-tunable
|
PHY tunable parameters
|
{"type": "object", "additionalProperties": false, "properties": {"downshift": {"oneOf": [{}, {"type": "array", "minItems": 3, "maxItems": 3, "items": [{}, {"type": "string", "enum": ["count"]}, {"type": "integer"}]}]}, "fast-link-down": {"oneOf": [{}, {"type": "array", "minItems": 3, "maxItems": 3, "items": [{}, {"type": "string", "enum": ["msec"]}, {"type": "integer"}]}]}, "energy-detect-power-down": {"oneOf": [{}, {"type": "array", "minItems": 3, "maxItems": 3, "items": [{}, {"type": "string", "enum": ["msec"]}, {"type": "integer"}]}]}}}
|
ifstate.conf.schema.json
|
downshift
|
enable downshift
|
{"oneOf": [{}, {"type": "array", "minItems": 3, "maxItems": 3, "items": [{}, {"type": "string", "enum": ["count"]}, {"type": "integer"}]}]}
|
ifstate.conf.schema.json
|
downshift
|
enable downshift
|
{}
|
ifstate.conf.schema.json
|
items
|
enable downshift
|
{}
|
ifstate.conf.schema.json
|
items
|
*REQUIRED*
|
{"type": "string", "enum": ["count"]}
|
ifstate.conf.schema.json
|
items
|
PHY downshift re-tries count
|
{"type": "integer"}
|
ifstate.conf.schema.json
|
fast-link-down
|
enable Fast Link Down
|
{"oneOf": [{}, {"type": "array", "minItems": 3, "maxItems": 3, "items": [{}, {"type": "string", "enum": ["msec"]}, {"type": "integer"}]}]}
|
ifstate.conf.schema.json
|
fast-link-down
|
enable Fast Link Down
|
{}
|
ifstate.conf.schema.json
|
items
|
enable Fast Link Down
|
{}
|
ifstate.conf.schema.json
|
items
|
*REQUIRED*
|
{"type": "string", "enum": ["msec"]}
|
ifstate.conf.schema.json
|
items
|
period after which the link is reported as down
|
{"type": "integer"}
|
ifstate.conf.schema.json
|
energy-detect-power-down
|
enable Energy Detect Power Down (EDPD)
|
{"oneOf": [{}, {"type": "array", "minItems": 3, "maxItems": 3, "items": [{}, {"type": "string", "enum": ["msec"]}, {"type": "integer"}]}]}
|
ifstate.conf.schema.json
|
energy-detect-power-down
|
enable EDPD
|
{}
|
ifstate.conf.schema.json
|
items
|
enable EDPD
|
{}
|
ifstate.conf.schema.json
|
items
|
*REQUIRED*
|
{"type": "string", "enum": ["msec"]}
|
ifstate.conf.schema.json
|
items
|
wake-up interval for Tx pulses
|
{"type": "integer"}
|
ifstate.conf.schema.json
|
priv-flags
|
private flags
|
{"type": "object"}
|
ifstate.conf.schema.json
|
fec
|
Forward Error Correction
|
{"type": "object", "additionalProperties": false, "properties": {"encoding": {"type": ["string", "array"], "enum": ["auto", "off", "RS", "BaseR", "LLRS"], "items": {"type": "string", "enum": ["auto", "RS", "BaseR", "LLRS"]}}}}
|
ifstate.conf.schema.json
|
encoding
|
FEC encoding
|
{"type": ["string", "array"], "enum": ["auto", "off", "RS", "BaseR", "LLRS"], "items": {"type": "string", "enum": ["auto", "RS", "BaseR", "LLRS"]}}
|
ifstate.conf.schema.json
|
cshaper
|
simple shaper setup based on the [cake](https://man7.org/linux/man-pages/man8/tc-cake.8.html) queue discipline; replaces any tc settings
|
{"type": "object", "additionalProperties": false, "properties": {"ingress": {"type": "string", "default": "unlimited"}, "egress": {"type": "string", "default": "unlimited"}, "profile": {"type": "string", "default": "default"}}}
|
ifstate.conf.schema.json
|
ingress
|
target ingress bandwidth
|
{"type": "string", "default": "unlimited"}
|
ifstate.conf.schema.json
|
egress
|
target egress bandwidth
|
{"type": "string", "default": "unlimited"}
|
ifstate.conf.schema.json
|
profile
|
cshaper profile
|
{"type": "string", "default": "default"}
|
ifstate.conf.schema.json
|
tc
|
settings for traffic control
|
{"type": "object", "additionalProperties": false, "properties": {"ingress": {"type": "boolean"}, "qdisc": {}, "filter": {"type": "array", "items": {"type": "object", "required": ["kind"], "properties": {"kind": {"type": "string", "enum": ["basic", "flow", "fw", "matchall"]}}, "oneOf": [{"additionalProperties": false, "properties": {"kind": {"type": "string", "enum": ["basic"]}, "protocol": {}, "prio": {}, "action": {}, "match": {"type": "object"}}}, {"properties": {"kind": {"type": "string", "enum": ["flow"]}, "protocol": {}, "prio": {}, "action": {}, "baseclass": {"type": "integer", "minimum": 0, "maximum": 65535, "default": 1}, "divisor": {"type": "integer", "minimum": 0, "maximum": 4294967295}, "or": {"type": "integer", "minimum": 0, "maximum": 4294967295}, "and": {"type": "integer", "minimum": 0, "maximum": 4294967295}, "xor": {"type": "integer", "minimum": 0, "maximum": 4294967295}, "rshift": {"type": "integer", "minimum": 0, "maximum": 4294967295}, "addend": {"type": "integer", "minimum": 0, "maximum": 4294967295}}, "oneOf": [{"required": ["kind", "mode", "key"], "properties": {"mode": {"type": "string", "enum": ["map"]}, "key": {"type": "string", "enum": ["src", "dst", "proto", "proto-src", "proto-dst", "iif", "priority", "mark", "nfct", "nfct-src", "nfct-dst", "nfct-proto-src", "nfct-proto-dst", "rt-classid", "sk-uid", "sk-gid", "vlan-tag", "rxhash"]}}}, {"required": ["kind", "mode", "keys"], "properties": {"mode": {"type": "string", "enum": ["hash"]}, "keys": {"type": "array", "items": {"type": "string", "enum": ["src", "dst", "proto", "proto-src", "proto-dst", "iif", "priority", "mark", "nfct", "nfct-src", "nfct-dst", "nfct-proto-src", "nfct-proto-dst", "rt-classid", "sk-uid", "sk-gid", "vlan-tag", "rxhash"]}}, "perturb": {"type": "integer", "minimum": 0, "maximum": 294967295}}}]}, {"additionalProperties": false, "required": ["kind", "handle"], "properties": {"kind": {"type": "string", "enum": ["fw"]}, "protocol": {}, "prio": {}, "action": {}, "handle": {"type": "integer", "minimum": 0}}}, {"additionalProperties": false, "properties": {"kind": {"type": "string", "enum": ["matchall"]}, "parent": {}, "protocol": {}, "prio": {}, "action": {}, "classid": {"type": "integer", "minimum": 0, "maximum": 4294967295}, "flags": {"type": "integer", "minimum": 0, "maximum": 4294967295}}}]}}}}
|
ifstate.conf.schema.json
|
ingress
|
enable the ingress qdisc for policing and shaping in ingress
|
{"type": "boolean"}
|
ifstate.conf.schema.json
|
qdisc
|
root queueing disciplines
|
{}
|
ifstate.conf.schema.json
|
filter
|
filter used by qdiscs
|
{"type": "array", "items": {"type": "object", "required": ["kind"], "properties": {"kind": {"type": "string", "enum": ["basic", "flow", "fw", "matchall"]}}, "oneOf": [{"additionalProperties": false, "properties": {"kind": {"type": "string", "enum": ["basic"]}, "protocol": {}, "prio": {}, "action": {}, "match": {"type": "object"}}}, {"properties": {"kind": {"type": "string", "enum": ["flow"]}, "protocol": {}, "prio": {}, "action": {}, "baseclass": {"type": "integer", "minimum": 0, "maximum": 65535, "default": 1}, "divisor": {"type": "integer", "minimum": 0, "maximum": 4294967295}, "or": {"type": "integer", "minimum": 0, "maximum": 4294967295}, "and": {"type": "integer", "minimum": 0, "maximum": 4294967295}, "xor": {"type": "integer", "minimum": 0, "maximum": 4294967295}, "rshift": {"type": "integer", "minimum": 0, "maximum": 4294967295}, "addend": {"type": "integer", "minimum": 0, "maximum": 4294967295}}, "oneOf": [{"required": ["kind", "mode", "key"], "properties": {"mode": {"type": "string", "enum": ["map"]}, "key": {"type": "string", "enum": ["src", "dst", "proto", "proto-src", "proto-dst", "iif", "priority", "mark", "nfct", "nfct-src", "nfct-dst", "nfct-proto-src", "nfct-proto-dst", "rt-classid", "sk-uid", "sk-gid", "vlan-tag", "rxhash"]}}}, {"required": ["kind", "mode", "keys"], "properties": {"mode": {"type": "string", "enum": ["hash"]}, "keys": {"type": "array", "items": {"type": "string", "enum": ["src", "dst", "proto", "proto-src", "proto-dst", "iif", "priority", "mark", "nfct", "nfct-src", "nfct-dst", "nfct-proto-src", "nfct-proto-dst", "rt-classid", "sk-uid", "sk-gid", "vlan-tag", "rxhash"]}}, "perturb": {"type": "integer", "minimum": 0, "maximum": 294967295}}}]}, {"additionalProperties": false, "required": ["kind", "handle"], "properties": {"kind": {"type": "string", "enum": ["fw"]}, "protocol": {}, "prio": {}, "action": {}, "handle": {"type": "integer", "minimum": 0}}}, {"additionalProperties": false, "properties": {"kind": {"type": "string", "enum": ["matchall"]}, "parent": {}, "protocol": {}, "prio": {}, "action": {}, "classid": {"type": "integer", "minimum": 0, "maximum": 4294967295}, "flags": {"type": "integer", "minimum": 0, "maximum": 4294967295}}}]}}
|
ifstate.conf.schema.json
|
kind
|
filter type
|
{"type": "string", "enum": ["basic", "flow", "fw", "matchall"]}
|
ifstate.conf.schema.json
|
items
|
[basic](https://man7.org/linux/man-pages/man8/tc-basic.8.html) - basic traffic control filter
|
{"additionalProperties": false, "properties": {"kind": {"type": "string", "enum": ["basic"]}, "protocol": {}, "prio": {}, "action": {}, "match": {"type": "object"}}}
|
ifstate.conf.schema.json
|
match
|
match packets using the [extended match infrastructure](https://man7.org/linux/man-pages/man8/tc-ematch.8.html)
|
{"type": "object"}
|
ifstate.conf.schema.json
|
items
|
[flow](https://man7.org/linux/man-pages/man8/tc-flow.8.html) - flow based traffic control filter
|
{"properties": {"kind": {"type": "string", "enum": ["flow"]}, "protocol": {}, "prio": {}, "action": {}, "baseclass": {"type": "integer", "minimum": 0, "maximum": 65535, "default": 1}, "divisor": {"type": "integer", "minimum": 0, "maximum": 4294967295}, "or": {"type": "integer", "minimum": 0, "maximum": 4294967295}, "and": {"type": "integer", "minimum": 0, "maximum": 4294967295}, "xor": {"type": "integer", "minimum": 0, "maximum": 4294967295}, "rshift": {"type": "integer", "minimum": 0, "maximum": 4294967295}, "addend": {"type": "integer", "minimum": 0, "maximum": 4294967295}}, "oneOf": [{"required": ["kind", "mode", "key"], "properties": {"mode": {"type": "string", "enum": ["map"]}, "key": {"type": "string", "enum": ["src", "dst", "proto", "proto-src", "proto-dst", "iif", "priority", "mark", "nfct", "nfct-src", "nfct-dst", "nfct-proto-src", "nfct-proto-dst", "rt-classid", "sk-uid", "sk-gid", "vlan-tag", "rxhash"]}}}, {"required": ["kind", "mode", "keys"], "properties": {"mode": {"type": "string", "enum": ["hash"]}, "keys": {"type": "array", "items": {"type": "string", "enum": ["src", "dst", "proto", "proto-src", "proto-dst", "iif", "priority", "mark", "nfct", "nfct-src", "nfct-dst", "nfct-proto-src", "nfct-proto-dst", "rt-classid", "sk-uid", "sk-gid", "vlan-tag", "rxhash"]}}, "perturb": {"type": "integer", "minimum": 0, "maximum": 294967295}}}]}
|
ifstate.conf.schema.json
|
baseclass
|
offset for the class ID calculation
|
{"type": "integer", "minimum": 0, "maximum": 65535, "default": 1}
|
ifstate.conf.schema.json
|
mode
|
filter mode
|
{"type": "string", "enum": ["map"]}
|
ifstate.conf.schema.json
|
key
|
map to class ID by key
|
{"type": "string", "enum": ["src", "dst", "proto", "proto-src", "proto-dst", "iif", "priority", "mark", "nfct", "nfct-src", "nfct-dst", "nfct-proto-src", "nfct-proto-dst", "rt-classid", "sk-uid", "sk-gid", "vlan-tag", "rxhash"]}
|
ifstate.conf.schema.json
|
mode
|
filter mode
|
{"type": "string", "enum": ["hash"]}
|
ifstate.conf.schema.json
|
keys
|
hash over keys for class ID calculation
|
{"type": "array", "items": {"type": "string", "enum": ["src", "dst", "proto", "proto-src", "proto-dst", "iif", "priority", "mark", "nfct", "nfct-src", "nfct-dst", "nfct-proto-src", "nfct-proto-dst", "rt-classid", "sk-uid", "sk-gid", "vlan-tag", "rxhash"]}}
|
ifstate.conf.schema.json
|
perturb
|
rehashing interval (in seconds)
|
{"type": "integer", "minimum": 0, "maximum": 294967295}
|
ifstate.conf.schema.json
|
items
|
[fw](https://man7.org/linux/man-pages/man8/tc-fw.8.html) - fwmark traffic control filter
|
{"additionalProperties": false, "required": ["kind", "handle"], "properties": {"kind": {"type": "string", "enum": ["fw"]}, "protocol": {}, "prio": {}, "action": {}, "handle": {"type": "integer", "minimum": 0}}}
|
ifstate.conf.schema.json
|
handle
|
fwmark (iptables) to match
|
{"type": "integer", "minimum": 0}
|
ifstate.conf.schema.json
|
items
|
[matchall](https://man7.org/linux/man-pages/man8/tc-matchall.8.html) - traffic control filter that matches every packet
|
{"additionalProperties": false, "properties": {"kind": {"type": "string", "enum": ["matchall"]}, "parent": {}, "protocol": {}, "prio": {}, "action": {}, "classid": {"type": "integer", "minimum": 0, "maximum": 4294967295}, "flags": {"type": "integer", "minimum": 0, "maximum": 4294967295}}}
|
ifstate.conf.schema.json
|
classid
|
push matching packets into class
|
{"type": "integer", "minimum": 0, "maximum": 4294967295}
|
ifstate.conf.schema.json
|
flags
|
process flags (1: SKIP_HW, 2: SKIP_SW)
|
{"type": "integer", "minimum": 0, "maximum": 4294967295}
|
ifstate.conf.schema.json
|
wireguard
|
settings for WireGuard interfaces
|
{"type": "object", "additionalProperties": false, "required": ["private_key"], "properties": {"private_key": {"type": "string"}, "listen_port": {"type": "integer", "minimum": 0, "maximum": 65535}, "fwmark": {"type": "integer", "minimum": 0, "maximum": 4294967295}, "peers": {"type": "array", "items": {"type": "object", "additionalProperties": false, "required": ["public_key"], "properties": {"public_key": {"type": "string"}, "preshared_key": {"type": "string"}, "endpoint": {"type": "string"}, "persistent_keepalive_interval": {"type": "integer", "minimum": 0, "maximum": 65535}, "allowedips": {"type": "array", "items": {"type": "string"}}}}}}}
|
ifstate.conf.schema.json
|
private_key
|
local private key (consider to use the `!include` tag to read the key from file)
|
{"type": "string"}
|
ifstate.conf.schema.json
|
listen_port
|
port for listening
|
{"type": "integer", "minimum": 0, "maximum": 65535}
|
ifstate.conf.schema.json
|
fwmark
|
fwmark for outgoing packets
|
{"type": "integer", "minimum": 0, "maximum": 4294967295}
|
ifstate.conf.schema.json
|
peers
|
list of peer definitions
|
{"type": "array", "items": {"type": "object", "additionalProperties": false, "required": ["public_key"], "properties": {"public_key": {"type": "string"}, "preshared_key": {"type": "string"}, "endpoint": {"type": "string"}, "persistent_keepalive_interval": {"type": "integer", "minimum": 0, "maximum": 65535}, "allowedips": {"type": "array", "items": {"type": "string"}}}}}
|
ifstate.conf.schema.json
|
public_key
|
the peer's public key
|
{"type": "string"}
|
ifstate.conf.schema.json
|
preshared_key
|
preshared key for post-quantum resistance (consider to use the `!include` tag to read the key from file)
|
{"type": "string"}
|
ifstate.conf.schema.json
|
endpoint
|
initial endpoint IP or hostname
|
{"type": "string"}
|
ifstate.conf.schema.json
|
persistent_keepalive_interval
|
keepalive interval seconds
|
{"type": "integer", "minimum": 0, "maximum": 65535}
|
ifstate.conf.schema.json
|
allowedips
|
list of prefixes in CIDR notation
|
{"type": "array", "items": {"type": "string"}}
|
ifstate.conf.schema.json
|
xdp
|
settings for XDP ("eXpress Data Path") BPF program
|
{"oneOf": [{"type": "boolean", "enum": [false]}, {"type": "object", "additionalProperties": false, "required": ["pinned"], "properties": {"mode": {}, "pinned": {"type": "string", "format": "^/sys/fs/bfd/."}}}, {"type": "object", "additionalProperties": false, "required": ["bpf"], "properties": {"mode": {}, "bpf": {"type": "string"}}}]}
|
ifstate.conf.schema.json
|
xdp
|
remove attached XDP program
|
{"type": "boolean", "enum": [false]}
|
ifstate.conf.schema.json
|
xdp
|
attach already pinned XDP program
|
{"type": "object", "additionalProperties": false, "required": ["pinned"], "properties": {"mode": {}, "pinned": {"type": "string", "format": "^/sys/fs/bfd/."}}}
|
ifstate.conf.schema.json
|
pinned
|
path to already pinned XDP program
|
{"type": "string", "format": "^/sys/fs/bfd/."}
|
ifstate.conf.schema.json
|
xdp
|
BPF program from ifstate's bpf config section
|
{"type": "object", "additionalProperties": false, "required": ["bpf"], "properties": {"mode": {}, "bpf": {"type": "string"}}}
|
ifstate.conf.schema.json
|
bpf
|
BPF program (key in bpf config section)
|
{"type": "string"}
|
ifstate.conf.schema.json
|
type
|
the type of this route
|
{"type": ["integer", "string"], "enum": ["unicast", "local", "broadcast", "anycast", "multicast", "blackhole", "unreachable", "prohibit", "throw", "nat", "xresolve"], "minimum": 1, "maximum": 11, "default": "unicast"}
|
ifstate.conf.schema.json
|
dev
|
the output device name
|
{"type": ["integer", "string"]}
|
ifstate.conf.schema.json
|
proto
|
the routing protool identifier of this route
|
{"type": ["integer", "string"], "default": "boot"}
|
ifstate.conf.schema.json
|
realm
|
the realm to which this route is assigned
|
{"type": ["integer", "string"]}
|
ifstate.conf.schema.json
|
scope
|
the scope of the destinations covered by the route prefix
|
{"type": ["integer", "string"]}
|
ifstate.conf.schema.json
|
table
|
the table to add this route to
|
{"type": ["integer", "string"], "default": "main"}
|
ifstate.conf.schema.json
|
to
|
the destination prefix of the route
|
{"type": "string"}
|
ifstate.conf.schema.json
|
via
|
address of the nexthop router
|
{"type": "string", "oneOf": [{"format": "ipv4"}, {"format": "ipv6"}]}
|
ifstate.conf.schema.json
|
src
|
the source address to prefer
|
{"type": "string", "oneOf": [{"format": "ipv4"}, {"format": "ipv6"}]}
|
ifstate.conf.schema.json
|
preference
|
preference of the route
|
{"type": "integer", "minimum": 0, "maximum": 4294967295, "default": 0}
|
ifstate.conf.schema.json
|
action
|
the type of this rule
|
{"type": ["integer", "string"], "enum": ["to_tbl", "blackhole", "unreachable", "prohibit"], "default": "to_tbl"}
|
ifstate.conf.schema.json
|
priority
|
the priority of this rule
|
{"type": "integer", "minimum": 0, "maximum": 4294967295}
|
ifstate.conf.schema.json
|
from
|
select the source prefix to match
|
{"type": "string"}
|
ifstate.conf.schema.json
|
to
|
select the destination prefix to match
|
{"type": "string"}
|
ifstate.conf.schema.json
|
iif
|
select the incoming device to match
|
{"type": "string"}
|
ifstate.conf.schema.json
|
oif
|
select the outgoing device to match
|
{"type": "string"}
|
ifstate.conf.schema.json
|
proto
|
routing protocol number (`/etc/iproute2/rt_protos`)
|
{"type": ["integer", "string"], "default": "unspec"}
|
ifstate.conf.schema.json
|
fwmark
|
select the *fwmark* value to match
|
{"type": "integer"}
|
ifstate.conf.schema.json
|
ipproto
|
select the ip protocol to match
|
{"type": ["integer", "string"]}
|
phraseapp.json
|
project_id
|
ID of the project
|
{"type": "string"}
|
phraseapp.json
|
file_format
|
File format name. See the format guide in the documentation for all supported file formats.
|
{"type": "string", "default": "yml"}
|
phraseapp.json
|
locale_id
|
Locale that should be downloaded. Locale ID or locale name are valid options
|
{"type": "string"}
|
phraseapp.json
|
encoding
|
Enforces a specific encoding on the file contents. Valid options are "UTF-8", "UTF-16" and "ISO-8859-1"
|
{"type": "string", "default": "UTF-8"}
|
phraseapp.json
|
phraseapp
|
Root element of the PhraseApp config
|
{"type": "object", "properties": {"defaults": {"type": "object", "properties": {"keys/list": {"type": "object", "properties": {"sort": {"type": "string", "default": "updated_at"}, "order": {"type": "string", "default": "desc"}}}}}, "host": {"type": "string"}, "access_token": {"type": "string"}, "file_format": {}, "project_id": {}, "push": {"type": "object", "properties": {"sources": {"minItems": 1, "type": "array", "items": {"type": "object", "properties": {"file": {"type": "string", "default": "<locale_name>.yml"}, "params": {"type": "object", "properties": {"branch": {"type": "string"}, "file_format": {}, "locale_id": {}, "tags": {"type": "string"}, "update_translations": {"type": "boolean", "default": false}, "update_descriptions": {"type": "boolean", "default": false}, "convert_emoji": {"type": "boolean", "default": false}, "skip_upload_tags": {"type": "boolean", "default": false}, "skip_unverification": {"type": "boolean", "default": false}, "file_encoding": {}, "format_options": {"type": "object", "properties": {"column_separator": {"type": "string", "default": ";"}}}}}}}}}}, "pull": {"type": "object", "properties": {"targets": {"minItems": 1, "type": "array", "items": {"type": "object", "properties": {"file": {"type": "string", "default": "<locale_name>.yml"}, "project_id": {}, "params": {"type": "object", "properties": {"branch": {"type": "string"}, "file_format": {}, "tag": {"type": "string", "default": ""}, "locale_id": {}, "include_empty_translations": {"type": "boolean", "default": false}, "keep_notranslate_tags": {"type": "boolean", "default": false}, "convert_emoji": {"type": "boolean", "default": false}, "encoding": {}, "skip_unverified_translations": {"type": "boolean", "default": false}, "fallback_locale_id": {"type": "string"}}}}}}}}}}
|
phraseapp.json
|
defaults
|
Default configuration for API endpoints
|
{"type": "object", "properties": {"keys/list": {"type": "object", "properties": {"sort": {"type": "string", "default": "updated_at"}, "order": {"type": "string", "default": "desc"}}}}}
|
phraseapp.json
|
host
|
API host URL. Only needs to be changed for OnPremise usage
|
{"type": "string"}
|
phraseapp.json
|
access_token
|
Access Token for authorization. Can be created in the user profile
|
{"type": "string"}
|
phraseapp.json
|
sources
|
Source files that will be uploaded on push
|
{"minItems": 1, "type": "array", "items": {"type": "object", "properties": {"file": {"type": "string", "default": "<locale_name>.yml"}, "params": {"type": "object", "properties": {"branch": {"type": "string"}, "file_format": {}, "locale_id": {}, "tags": {"type": "string"}, "update_translations": {"type": "boolean", "default": false}, "update_descriptions": {"type": "boolean", "default": false}, "convert_emoji": {"type": "boolean", "default": false}, "skip_upload_tags": {"type": "boolean", "default": false}, "skip_unverification": {"type": "boolean", "default": false}, "file_encoding": {}, "format_options": {"type": "object", "properties": {"column_separator": {"type": "string", "default": ";"}}}}}}}}
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.