schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
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.HeadDefinition
Rest HEAD 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"}, "enable-cors": {"type": "boolean"}, "id": {"type": "string"}, "out-type": {"type": "string"}, "param": {"type": "array", "items": {}}, "path": {"type": "string"}, "produces": {"type": "string"}, "response-message": {"type": "array", "items": {}}, "route-id": {"type": "string"}, "security": {"type": "array", "items": {}}, "skip-binding-on-error-code": {"type": "boolean"}, "to": {}, "type": {"type": "string"}}}
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, body); returns HTTP Status 400 if validation error. 4) Parsing error of the message body (JSon, XML or Auto binding mode must be enabled); returns HTTP Status 400 if validation error.
{"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.MutualTLSDefinition
Rest security mutual TLS authentication 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.OAuth2Definition
Rest security OAuth2 definition
{"type": "object", "properties": {"authorization-url": {"type": "string"}, "flow": {"type": "string", "enum": ["implicit", "password", "application", "clientCredentials", "accessCode", "authorizationCode"]}, "key": {"type": "string"}, "refresh-url": {"type": "string"}, "scopes": {"type": "array", "items": {}}, "token-url": {"type": "string"}}, "required": ["key"]}
camel-yaml-dsl.json
authorization-url
The authorization URL to be used for this flow. This SHOULD be in the form of a URL. Required for implicit and access code flows
{"type": "string"}
camel-yaml-dsl.json
description
A short description for security scheme.
{"type": "string"}
camel-yaml-dsl.json
flow
The flow used by the OAuth2 security scheme. Valid values are implicit, password, application or accessCode.
{"type": "string", "enum": ["implicit", "password", "application", "clientCredentials", "accessCode", "authorizationCode"]}
camel-yaml-dsl.json
key
Key used to refer to this security definition
{"type": "string"}
camel-yaml-dsl.json
refresh-url
The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL.
{"type": "string"}
camel-yaml-dsl.json
scopes
The available scopes for an OAuth2 security scheme
{"type": "array", "items": {}}
camel-yaml-dsl.json
token-url
The token URL to be used for this flow. This SHOULD be in the form of a URL. Required for password, application, and access code flows.
{"type": "string"}
camel-yaml-dsl.json
org.apache.camel.model.rest.OpenIdConnectDefinition
Rest security OpenID Connect definition
{"type": "object", "properties": {"key": {"type": "string"}, "url": {"type": "string"}}, "required": ["key", "url"]}
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
url
OpenId Connect URL to discover OAuth2 configuration values.
{"type": "string"}
camel-yaml-dsl.json
org.apache.camel.model.rest.ParamDefinition
To specify the rest operation parameters.
{"type": "object", "properties": {"allowable-values": {"type": "array", "items": {}}, "array-type": {"type": "string", "default": "string"}, "collection-format": {"type": "string", "default": "csv", "enum": ["csv", "multi", "pipes", "ssv", "tsv"]}, "data-format": {"type": "string"}, "data-type": {"type": "string", "default": "string"}, "default-value": {"type": "string"}, "examples": {"type": "array", "items": {}}, "name": {"type": "string"}, "required": {"type": "boolean"}, "type": {"type": "string", "default": "path", "enum": ["body", "formData", "header", "path", "query"]}}, "required": ["name"]}
camel-yaml-dsl.json
allowable-values
Sets the parameter list of allowable values (enum).
{"type": "array", "items": {}}
camel-yaml-dsl.json
array-type
Sets the parameter array type. Required if data type is array. Describes the type of items in the array.
{"type": "string", "default": "string"}
camel-yaml-dsl.json
collection-format
Sets the parameter collection format.
{"type": "string", "default": "csv", "enum": ["csv", "multi", "pipes", "ssv", "tsv"]}
camel-yaml-dsl.json
data-format
Sets the parameter data format.
{"type": "string"}
camel-yaml-dsl.json
data-type
Sets the parameter data type.
{"type": "string", "default": "string"}
camel-yaml-dsl.json
default-value
Sets the parameter default value.
{"type": "string"}
camel-yaml-dsl.json
description
Sets the parameter description.
{"type": "string"}
camel-yaml-dsl.json
examples
Sets the parameter examples.
{"type": "array", "items": {}}
camel-yaml-dsl.json
name
Sets the parameter name.
{"type": "string"}
camel-yaml-dsl.json
required
Sets the parameter required flag.
{"type": "boolean"}
camel-yaml-dsl.json
type
Sets the parameter type.
{"type": "string", "default": "path", "enum": ["body", "formData", "header", "path", "query"]}
camel-yaml-dsl.json
org.apache.camel.model.rest.PatchDefinition
Rest PATCH 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"}, "enable-cors": {"type": "boolean"}, "id": {"type": "string"}, "out-type": {"type": "string"}, "param": {"type": "array", "items": {}}, "path": {"type": "string"}, "produces": {"type": "string"}, "response-message": {"type": "array", "items": {}}, "route-id": {"type": "string"}, "security": {"type": "array", "items": {}}, "skip-binding-on-error-code": {"type": "boolean"}, "to": {}, "type": {"type": "string"}}}
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, body); returns HTTP Status 400 if validation error. 4) Parsing error of the message body (JSon, XML or Auto binding mode must be enabled); returns HTTP Status 400 if validation error.
{"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.PostDefinition
Rest POST 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"}, "enable-cors": {"type": "boolean"}, "id": {"type": "string"}, "out-type": {"type": "string"}, "param": {"type": "array", "items": {}}, "path": {"type": "string"}, "produces": {"type": "string"}, "response-message": {"type": "array", "items": {}}, "route-id": {"type": "string"}, "security": {"type": "array", "items": {}}, "skip-binding-on-error-code": {"type": "boolean"}, "to": {}, "type": {"type": "string"}}}
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, body); returns HTTP Status 400 if validation error. 4) Parsing error of the message body (JSon, XML or Auto binding mode must be enabled); returns HTTP Status 400 if validation error.
{"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.PutDefinition
Rest PUT 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"}, "enable-cors": {"type": "boolean"}, "id": {"type": "string"}, "out-type": {"type": "string"}, "param": {"type": "array", "items": {}}, "path": {"type": "string"}, "produces": {"type": "string"}, "response-message": {"type": "array", "items": {}}, "route-id": {"type": "string"}, "security": {"type": "array", "items": {}}, "skip-binding-on-error-code": {"type": "boolean"}, "to": {}, "type": {"type": "string"}}}
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, body); returns HTTP Status 400 if validation error. 4) Parsing error of the message body (JSon, XML or Auto binding mode must be enabled); returns HTTP Status 400 if validation error.
{"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.ResponseHeaderDefinition
To specify the rest operation response headers.
{"type": "object", "properties": {"allowable-values": {"type": "array", "items": {}}, "array-type": {"type": "string", "default": "string"}, "collection-format": {"type": "string", "default": "csv", "enum": ["csv", "multi", "pipes", "ssv", "tsv"]}, "data-format": {"type": "string"}, "data-type": {"type": "string", "default": "string"}, "example": {"type": "string"}, "name": {"type": "string"}}, "required": ["name"]}