schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
camel-yaml-dsl.json
regex
If the token is a regular expression pattern. The default value is false
{"type": "boolean"}
camel-yaml-dsl.json
skip-first
To skip the very first element
{"type": "boolean"}
camel-yaml-dsl.json
token
The (start) token to use as tokenizer, for example you can use the new line token. You can use simple language as the token to support dynamic tokens.
{"type": "string"}
camel-yaml-dsl.json
trim
Whether to trim the value to remove leading and trailing whitespaces and line breaks
{"type": "boolean"}
camel-yaml-dsl.json
xml
Whether the input is XML messages. This option must be set to true if working with XML payloads.
{"type": "boolean"}
camel-yaml-dsl.json
org.apache.camel.model.language.XMLTokenizerExpression
Tokenize XML payloads.
{"oneOf": [{"type": "string"}, {"type": "object", "properties": {"expression": {"type": "string"}, "group": {"type": "number"}, "header-name": {"type": "string"}, "id": {"type": "string"}, "mode": {"type": "string", "default": "i", "enum": ["i", "w", "u", "t"]}, "namespace": {"type": "array", "items": {}}, "property-na...
camel-yaml-dsl.json
expression
The expression value in your chosen language syntax
{"type": "string"}
camel-yaml-dsl.json
group
To group N parts together
{"type": "number"}
camel-yaml-dsl.json
header-name
Name of header to use as input, instead of the message body It has as higher precedent than the propertyName if both are set.
{"type": "string"}
camel-yaml-dsl.json
id
Sets the id of this node
{"type": "string"}
camel-yaml-dsl.json
mode
The extraction mode. The available extraction modes are: i - injecting the contextual namespace bindings into the extracted token (default) w - wrapping the extracted token in its ancestor context u - unwrapping the extracted token to its child content t - extracting the text content of the specified element
{"type": "string", "default": "i", "enum": ["i", "w", "u", "t"]}
camel-yaml-dsl.json
namespace
Injects the XML Namespaces of prefix - uri mappings
{"type": "array", "items": {}}
camel-yaml-dsl.json
property-name
Name of property to use as input, instead of the message body. It has a lower precedent than the headerName if both are set.
{"type": "string"}
camel-yaml-dsl.json
trim
Whether to trim the value to remove leading and trailing whitespaces and line breaks
{"type": "boolean"}
camel-yaml-dsl.json
org.apache.camel.model.language.XPathExpression
Evaluates an XPath expression against an XML payload.
{"oneOf": [{"type": "string"}, {"type": "object", "properties": {"document-type": {"type": "string"}, "expression": {"type": "string"}, "factory-ref": {"type": "string"}, "header-name": {"type": "string"}, "id": {"type": "string"}, "log-namespaces": {"type": "boolean"}, "namespace": {"type": "array", "items": {}}, "obj...
camel-yaml-dsl.json
document-type
Name of class for document type The default value is org.w3c.dom.Document
{"type": "string"}
camel-yaml-dsl.json
expression
The expression value in your chosen language syntax
{"type": "string"}
camel-yaml-dsl.json
factory-ref
References to a custom XPathFactory to lookup in the registry
{"type": "string"}
camel-yaml-dsl.json
header-name
Name of header to use as input, instead of the message body It has as higher precedent than the propertyName if both are set.
{"type": "string"}
camel-yaml-dsl.json
id
Sets the id of this node
{"type": "string"}
camel-yaml-dsl.json
log-namespaces
Whether to log namespaces which can assist during troubleshooting
{"type": "boolean"}
camel-yaml-dsl.json
namespace
Injects the XML Namespaces of prefix - uri mappings
{"type": "array", "items": {}}
camel-yaml-dsl.json
object-model
The XPath object model to use
{"type": "string"}
camel-yaml-dsl.json
pre-compile
Whether to enable pre-compiling the xpath expression during initialization phase. pre-compile is enabled by default. This can be used to turn off, for example in cases the compilation phase is desired at the starting phase, such as if the application is ahead of time compiled (for example with camel-quarkus) which woul...
{"type": "boolean"}
camel-yaml-dsl.json
property-name
Name of property to use as input, instead of the message body. It has a lower precedent than the headerName if both are set.
{"type": "string"}
camel-yaml-dsl.json
result-type
Sets the class name of the result type (type from output) The default result type is NodeSet
{"type": "string", "default": "NODESET", "enum": ["NUMBER", "STRING", "BOOLEAN", "NODESET", "NODE"]}
camel-yaml-dsl.json
saxon
Whether to use Saxon.
{"type": "boolean"}
camel-yaml-dsl.json
thread-safety
Whether to enable thread-safety for the returned result of the xpath expression. This applies to when using NODESET as the result type, and the returned set has multiple elements. In this situation there can be thread-safety issues if you process the NODESET concurrently such as from a Camel Splitter EIP in parallel pr...
{"type": "boolean"}
camel-yaml-dsl.json
trim
Whether to trim the value to remove leading and trailing whitespaces and line breaks
{"type": "boolean"}
camel-yaml-dsl.json
org.apache.camel.model.language.XQueryExpression
Evaluates an XQuery expressions against an XML payload.
{"oneOf": [{"type": "string"}, {"type": "object", "properties": {"configuration-ref": {"type": "string"}, "expression": {"type": "string"}, "header-name": {"type": "string"}, "id": {"type": "string"}, "namespace": {"type": "array", "items": {}}, "property-name": {"type": "string"}, "result-type": {"type": "string"}, "t...
camel-yaml-dsl.json
configuration-ref
Reference to a saxon configuration instance in the registry to use for xquery (requires camel-saxon). This may be needed to add custom functions to a saxon configuration, so these custom functions can be used in xquery expressions.
{"type": "string"}
camel-yaml-dsl.json
expression
The expression value in your chosen language syntax
{"type": "string"}
camel-yaml-dsl.json
header-name
Name of header to use as input, instead of the message body It has as higher precedent than the propertyName if both are set.
{"type": "string"}
camel-yaml-dsl.json
id
Sets the id of this node
{"type": "string"}
camel-yaml-dsl.json
namespace
Injects the XML Namespaces of prefix - uri mappings
{"type": "array", "items": {}}
camel-yaml-dsl.json
property-name
Name of property to use as input, instead of the message body. It has a lower precedent than the headerName if both are set.
{"type": "string"}
camel-yaml-dsl.json
result-type
Sets the class of the result type (type from output)
{"type": "string"}
camel-yaml-dsl.json
trim
Whether to trim the value to remove leading and trailing whitespaces and line breaks
{"type": "boolean"}
camel-yaml-dsl.json
type
Sets the class name of the result type (type from output) The default result type is NodeSet
{"type": "string"}
camel-yaml-dsl.json
org.apache.camel.model.loadbalancer.CustomLoadBalancerDefinition
To use a custom load balancer implementation.
{"oneOf": [{"type": "string"}, {"type": "object", "properties": {"id": {"type": "string"}, "ref": {"type": "string"}}}], "required": ["ref"]}
camel-yaml-dsl.json
id
The id of this node
{"type": "string"}
camel-yaml-dsl.json
ref
Refers to the custom load balancer to lookup from the registry
{"type": "string"}
camel-yaml-dsl.json
org.apache.camel.model.loadbalancer.FailoverLoadBalancerDefinition
In case of failures the exchange will be tried on the next endpoint.
{"type": "object", "properties": {"exception": {"type": "array", "items": {"type": "string"}}, "id": {"type": "string"}, "maximum-failover-attempts": {"type": "string", "default": "-1"}, "round-robin": {"type": "string"}, "sticky": {"type": "string"}}}
camel-yaml-dsl.json
exception
A list of class names for specific exceptions to monitor. If no exceptions are configured then all exceptions are monitored
{"type": "array", "items": {"type": "string"}}
camel-yaml-dsl.json
id
The id of this node
{"type": "string"}
camel-yaml-dsl.json
maximum-failover-attempts
A value to indicate after X failover attempts we should exhaust (give up). Use -1 to indicate never give up and continuously try to failover. Use 0 to never failover. And use e.g. 3 to failover at most 3 times before giving up. his option can be used whether or not roundRobin is enabled or not.
{"type": "string", "default": "-1"}
camel-yaml-dsl.json
round-robin
Whether or not the failover load balancer should operate in round robin mode or not. If not, then it will always start from the first endpoint when a new message is to be processed. In other words it restart from the top for every message. If round robin is enabled, then it keeps state and will continue with the next e...
{"type": "string"}
camel-yaml-dsl.json
sticky
Whether or not the failover load balancer should operate in sticky mode or not. If not, then it will always start from the first endpoint when a new message is to be processed. In other words it restart from the top for every message. If sticky is enabled, then it keeps state and will continue with the last known good ...
{"type": "string"}
camel-yaml-dsl.json
org.apache.camel.model.loadbalancer.RandomLoadBalancerDefinition
The destination endpoints are selected by random.
{"type": "object", "properties": {"id": {"type": "string"}}}
camel-yaml-dsl.json
id
The id of this node
{"type": "string"}
camel-yaml-dsl.json
org.apache.camel.model.loadbalancer.RoundRobinLoadBalancerDefinition
The destination endpoints are selected in a round-robin fashion. This is a well known and classic policy, which spreads the load evenly.
{"type": "object", "properties": {"id": {"type": "string"}}}
camel-yaml-dsl.json
id
The id of this node
{"type": "string"}
camel-yaml-dsl.json
org.apache.camel.model.loadbalancer.StickyLoadBalancerDefinition
Sticky load balancing using an expression to calculate a correlation key to perform the sticky load balancing.
{"type": "object", "properties": {"correlation-expression": {}, "id": {"type": "string"}}}
camel-yaml-dsl.json
correlation-expression
The correlation expression to use to calculate the correlation key
{}
camel-yaml-dsl.json
id
The id of this node
{"type": "string"}
camel-yaml-dsl.json
org.apache.camel.model.loadbalancer.TopicLoadBalancerDefinition
Topic which sends to all destinations.
{"type": "object", "properties": {"id": {"type": "string"}}}
camel-yaml-dsl.json
id
The id of this node
{"type": "string"}
camel-yaml-dsl.json
org.apache.camel.model.loadbalancer.WeightedLoadBalancerDefinition
Uses a weighted load distribution ratio for each server with respect to others.
{"type": "object", "properties": {"distribution-ratio": {"type": "string"}, "distribution-ratio-delimiter": {"type": "string", "default": ","}, "id": {"type": "string"}, "round-robin": {"type": "boolean"}}, "required": ["distribution-ratio"]}
camel-yaml-dsl.json
distribution-ratio
The distribution ratio is a delimited String consisting on integer weights separated by delimiters for example 2,3,5. The distributionRatio must match the number of endpoints and/or processors specified in the load balancer list.
{"type": "string"}
camel-yaml-dsl.json
distribution-ratio-delimiter
Delimiter used to specify the distribution ratio. The default value is , (comma)
{"type": "string", "default": ","}
camel-yaml-dsl.json
id
The id of this node
{"type": "string"}
camel-yaml-dsl.json
round-robin
To enable round robin mode. By default the weighted distribution mode is used. The default value is false.
{"type": "boolean"}
camel-yaml-dsl.json
org.apache.camel.model.rest.ApiKeyDefinition
Rest security basic auth definition
{"type": "object", "properties": {"in-cookie": {"type": "boolean"}, "in-header": {"type": "boolean"}, "in-query": {"type": "boolean"}, "key": {"type": "string"}, "name": {"type": "string"}}, "required": ["key", "name"]}
camel-yaml-dsl.json
description
A short description for security scheme.
{"type": "string"}
camel-yaml-dsl.json
in-cookie
To use a cookie as the location of the API key.
{"type": "boolean"}
camel-yaml-dsl.json
in-header
To use header as the location of the API key.
{"type": "boolean"}
camel-yaml-dsl.json
in-query
To use query parameter as the location of the API key.
{"type": "boolean"}
camel-yaml-dsl.json
key
Key used to refer to this security definition
{"type": "string"}
camel-yaml-dsl.json
name
The name of the header or query parameter to be used.
{"type": "string"}
camel-yaml-dsl.json
org.apache.camel.model.rest.BasicAuthDefinition
Rest security basic auth definition
{"type": "object", "properties": {"key": {"type": "string"}}, "required": ["key"]}
camel-yaml-dsl.json
description
A short description for security scheme.
{"type": "string"}
camel-yaml-dsl.json
key
Key used to refer to this security definition
{"type": "string"}
camel-yaml-dsl.json
org.apache.camel.model.rest.BearerTokenDefinition
Rest security bearer token authentication definition
{"type": "object", "properties": {"format": {"type": "string"}, "key": {"type": "string"}}, "required": ["key"]}
camel-yaml-dsl.json
description
A short description for security scheme.
{"type": "string"}
camel-yaml-dsl.json
format
A hint to the client to identify how the bearer token is formatted.
{"type": "string"}
camel-yaml-dsl.json
key
Key used to refer to this security definition
{"type": "string"}
camel-yaml-dsl.json
org.apache.camel.model.rest.DeleteDefinition
Rest DELETE command
{"type": "object", "properties": {"api-docs": {"type": "boolean"}, "binding-mode": {"type": "string", "default": "off", "enum": ["off", "auto", "json", "xml", "json_xml"]}, "client-request-validation": {"type": "boolean"}, "consumes": {"type": "string"}, "deprecated": {"type": "boolean"}, "disabled": {"type": "boolean"...
camel-yaml-dsl.json
api-docs
Whether to include or exclude this rest operation in API documentation. The default value is true.
{"type": "boolean"}
camel-yaml-dsl.json
binding-mode
Sets the binding mode to use. This option will override what may be configured on a parent level The default value is off
{"type": "string", "default": "off", "enum": ["off", "auto", "json", "xml", "json_xml"]}
camel-yaml-dsl.json
client-request-validation
Whether to enable validation of the client request to check: 1) Content-Type header matches what the Rest DSL consumes; returns HTTP Status 415 if validation error. 2) Accept header matches what the Rest DSL produces; returns HTTP Status 406 if validation error. 3) Missing required data (query parameters, HTTP headers,...
{"type": "boolean"}
camel-yaml-dsl.json
consumes
To define the content type what the REST service consumes (accept as input), such as application/xml or application/json. This option will override what may be configured on a parent level
{"type": "string"}
camel-yaml-dsl.json
deprecated
Marks this rest operation as deprecated in OpenApi documentation.
{"type": "boolean"}
camel-yaml-dsl.json
description
Sets the id of this node
{"type": "string"}
camel-yaml-dsl.json
disabled
Whether to disable this REST service from the route during build time. Once an REST service has been disabled then it cannot be enabled later at runtime.
{"type": "boolean"}
camel-yaml-dsl.json
id
Sets the id of this node
{"type": "string"}
camel-yaml-dsl.json
out-type
Sets the class name to use for binding from POJO to output for the outgoing data This option will override what may be configured on a parent level The name of the class of the input data. Append a to the end of the name if you want the input to be an array type.
{"type": "string"}
camel-yaml-dsl.json
path
The path mapping URIs of this REST operation such as /{id}.
{"type": "string"}
camel-yaml-dsl.json
produces
To define the content type what the REST service produces (uses for output), such as application/xml or application/json This option will override what may be configured on a parent level
{"type": "string"}
camel-yaml-dsl.json
route-id
Sets the id of the route
{"type": "string"}
camel-yaml-dsl.json
skip-binding-on-error-code
Whether to skip binding on output if there is a custom HTTP error code header. This allows to build custom error messages that do not bind to json / xml etc, as success messages otherwise will do. This option will override what may be configured on a parent level
{"type": "boolean"}
camel-yaml-dsl.json
to
The Camel endpoint this REST service will call, such as a direct endpoint to link to an existing route that handles this REST call.
{}
camel-yaml-dsl.json
type
Sets the class name to use for binding from input to POJO for the incoming data This option will override what may be configured on a parent level. The name of the class of the input data. Append a to the end of the name if you want the input to be an array type.
{"type": "string"}
camel-yaml-dsl.json
org.apache.camel.model.rest.GetDefinition
Rest GET command
{"type": "object", "properties": {"api-docs": {"type": "boolean"}, "binding-mode": {"type": "string", "default": "off", "enum": ["off", "auto", "json", "xml", "json_xml"]}, "client-request-validation": {"type": "boolean"}, "consumes": {"type": "string"}, "deprecated": {"type": "boolean"}, "disabled": {"type": "boolean"...
camel-yaml-dsl.json
api-docs
Whether to include or exclude this rest operation in API documentation. The default value is true.
{"type": "boolean"}
camel-yaml-dsl.json
binding-mode
Sets the binding mode to use. This option will override what may be configured on a parent level The default value is off
{"type": "string", "default": "off", "enum": ["off", "auto", "json", "xml", "json_xml"]}
camel-yaml-dsl.json
client-request-validation
Whether to enable validation of the client request to check: 1) Content-Type header matches what the Rest DSL consumes; returns HTTP Status 415 if validation error. 2) Accept header matches what the Rest DSL produces; returns HTTP Status 406 if validation error. 3) Missing required data (query parameters, HTTP headers,...
{"type": "boolean"}
camel-yaml-dsl.json
consumes
To define the content type what the REST service consumes (accept as input), such as application/xml or application/json. This option will override what may be configured on a parent level
{"type": "string"}
camel-yaml-dsl.json
deprecated
Marks this rest operation as deprecated in OpenApi documentation.
{"type": "boolean"}
camel-yaml-dsl.json
description
Sets the id of this node
{"type": "string"}
camel-yaml-dsl.json
disabled
Whether to disable this REST service from the route during build time. Once an REST service has been disabled then it cannot be enabled later at runtime.
{"type": "boolean"}