{
  "model": {
    "kind": "model",
    "name": "restConfiguration",
    "title": "Rest Configuration",
    "description": "To configure rest",
    "deprecated": false,
    "label": "rest",
    "javaType": "org.apache.camel.model.rest.RestConfigurationDefinition",
    "input": false,
    "output": false
  },
  "properties": {
    "component": { "kind": "attribute", "displayName": "Component", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "secret": false, "description": "The Camel Rest component to use for the REST transport (consumer), such as netty-http, jetty, servlet, undertow. If no component has been explicit configured, then Camel will lookup if there is a Camel component that integrates with the Rest DSL, or if a org.apache.camel.spi.RestConsumerFactory is registered in the registry. If either one is found, then that is being used." },
    "apiComponent": { "kind": "attribute", "displayName": "Api Component", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "secret": false, "defaultValue": "swagger", "description": "The name of the Camel component to use as the REST API (such as swagger)" },
    "producerComponent": { "kind": "attribute", "displayName": "Producer Component", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "secret": false, "description": "Sets the name of the Camel component to use as the REST producer" },
    "scheme": { "kind": "attribute", "displayName": "Scheme", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "secret": false, "description": "The scheme to use for exposing the REST service. Usually http or https is supported. The default value is http" },
    "host": { "kind": "attribute", "displayName": "Host", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "secret": false, "description": "The hostname to use for exposing the REST service." },
    "apiHost": { "kind": "attribute", "displayName": "Api Host", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "secret": false, "description": "To use an specific hostname for the API documentation (eg swagger) This can be used to override the generated host with this configured hostname" },
    "useXForwardHeaders": { "kind": "attribute", "displayName": "Use XForward Headers", "required": false, "type": "boolean", "javaType": "java.lang.Boolean", "deprecated": false, "secret": false, "defaultValue": true, "description": "Whether to use X-Forward headers for Host and related setting. The default value is true." },
    "port": { "kind": "attribute", "displayName": "Port", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "secret": false, "description": "The port number to use for exposing the REST service. Notice if you use servlet component then the port number configured here does not apply, as the port number in use is the actual port number the servlet component is using. eg if using Apache Tomcat its the tomcat http port, if using Apache Karaf its the HTTP service in Karaf that uses port 8181 by default etc. Though in those situations setting the port number here, allows tooling and JMX to know the port number, so its recommended to set the port number to the number that the servlet engine uses." },
    "producerApiDoc": { "kind": "attribute", "displayName": "Producer Api Doc", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "secret": false, "description": "Sets the location of the api document (swagger api) the REST producer will use to validate the REST uri and query parameters are valid accordingly to the api document. This requires adding camel-swagger-java to the classpath, and any miss configuration will let Camel fail on startup and report the error(s). The location of the api document is loaded from classpath by default, but you can use file: or http: to refer to resources to load from file or http url." },
    "contextPath": { "kind": "attribute", "displayName": "Context Path", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "secret": false, "description": "Sets a leading context-path the REST services will be using. This can be used when using components such as camel-servlet where the deployed web application is deployed using a context-path. Or for components such as camel-jetty or camel-netty-http that includes a HTTP server." },
    "apiContextPath": { "kind": "attribute", "displayName": "Api Context Path", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "secret": false, "description": "Sets a leading API context-path the REST API services will be using. This can be used when using components such as camel-servlet where the deployed web application is deployed using a context-path." },
    "apiContextRouteId": { "kind": "attribute", "displayName": "Api Context Route Id", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "secret": false, "description": "Sets the route id to use for the route that services the REST API. The route will by default use an auto assigned route id." },
    "apiContextIdPattern": { "kind": "attribute", "displayName": "Api Context Id Pattern", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "secret": false, "description": "Sets an CamelContext id pattern to only allow Rest APIs from rest services within CamelContext's which name matches the pattern. The pattern #name# refers to the CamelContext name, to match on the current CamelContext only. For any other value, the pattern uses the rules from PatternHelper#matchPattern(String,String)" },
    "apiContextListing": { "kind": "attribute", "displayName": "Api Context Listing", "required": false, "type": "boolean", "javaType": "java.lang.Boolean", "deprecated": false, "secret": false, "defaultValue": false, "description": "Sets whether listing of all available CamelContext's with REST services in the JVM is enabled. If enabled it allows to discover these contexts, if false then only the current CamelContext is in use." },
    "apiVendorExtension": { "kind": "attribute", "displayName": "Api Vendor Extension", "required": false, "type": "boolean", "javaType": "java.lang.Boolean", "deprecated": false, "secret": false, "defaultValue": false, "description": "Whether vendor extension is enabled in the Rest APIs. If enabled then Camel will include additional information as vendor extension (eg keys starting with x-) such as route ids, class names etc. Not all 3rd party API gateways and tools supports vendor-extensions when importing your API docs." },
    "hostNameResolver": { "kind": "attribute", "displayName": "Host Name Resolver", "required": false, "type": "enum", "javaType": "org.apache.camel.model.rest.RestHostNameResolver", "enum": [ "allLocalIp", "localHostName", "localIp" ], "deprecated": false, "secret": false, "description": "If no hostname has been explicit configured, then this resolver is used to compute the hostname the REST service will be using." },
    "bindingMode": { "kind": "attribute", "displayName": "Binding Mode", "required": false, "type": "enum", "javaType": "org.apache.camel.model.rest.RestBindingMode", "enum": [ "auto", "json", "json_xml", "off", "xml" ], "deprecated": false, "secret": false, "defaultValue": "off", "description": "Sets the binding mode to use. The default value is off" },
    "skipBindingOnErrorCode": { "kind": "attribute", "displayName": "Skip Binding On Error Code", "required": false, "type": "boolean", "javaType": "java.lang.Boolean", "deprecated": false, "secret": false, "defaultValue": false, "description": "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." },
    "clientRequestValidation": { "kind": "attribute", "displayName": "Client Request Validation", "required": false, "type": "boolean", "javaType": "java.lang.Boolean", "deprecated": false, "secret": false, "defaultValue": false, "description": "Whether to enable validation of the client request to check whether the Content-Type and Accept headers from the client is supported by the Rest-DSL configuration of its consumes\/produces settings. This can be turned on, to enable this check. In case of validation error, then HTTP Status codes 415 or 406 is returned. The default value is false." },
    "enableCORS": { "kind": "attribute", "displayName": "Enable CORS", "required": false, "type": "boolean", "javaType": "java.lang.Boolean", "deprecated": false, "secret": false, "defaultValue": false, "description": "Whether to enable CORS headers in the HTTP response. The default value is false." },
    "jsonDataFormat": { "kind": "attribute", "displayName": "Json Data Format", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "secret": false, "description": "Name of specific json data format to use. By default json-jackson will be used. Important: This option is only for setting a custom name of the data format, not to refer to an existing data format instance." },
    "xmlDataFormat": { "kind": "attribute", "displayName": "Xml Data Format", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "secret": false, "description": "Name of specific XML data format to use. By default jaxb will be used. Important: This option is only for setting a custom name of the data format, not to refer to an existing data format instance." },
    "componentProperty": { "kind": "element", "displayName": "Component Property", "required": false, "type": "array", "javaType": "java.util.List<org.apache.camel.model.rest.RestPropertyDefinition>", "deprecated": false, "secret": false, "description": "Allows to configure as many additional properties for the rest component in use." },
    "endpointProperty": { "kind": "element", "displayName": "Endpoint Property", "required": false, "type": "array", "javaType": "java.util.List<org.apache.camel.model.rest.RestPropertyDefinition>", "deprecated": false, "secret": false, "description": "Allows to configure as many additional properties for the rest endpoint in use." },
    "consumerProperty": { "kind": "element", "displayName": "Consumer Property", "required": false, "type": "array", "javaType": "java.util.List<org.apache.camel.model.rest.RestPropertyDefinition>", "deprecated": false, "secret": false, "description": "Allows to configure as many additional properties for the rest consumer in use." },
    "dataFormatProperty": { "kind": "element", "displayName": "Data Format Property", "required": false, "type": "array", "javaType": "java.util.List<org.apache.camel.model.rest.RestPropertyDefinition>", "deprecated": false, "secret": false, "description": "Allows to configure as many additional properties for the data formats in use. For example set property prettyPrint to true to have json outputted in pretty mode. The properties can be prefixed to denote the option is only for either JSON or XML and for either the IN or the OUT. The prefixes are: json.in. json.out. xml.in. xml.out. For example a key with value xml.out.mustBeJAXBElement is only for the XML data format for the outgoing. A key without a prefix is a common key for all situations." },
    "apiProperty": { "kind": "element", "displayName": "Api Property", "required": false, "type": "array", "javaType": "java.util.List<org.apache.camel.model.rest.RestPropertyDefinition>", "deprecated": false, "secret": false, "description": "Allows to configure as many additional properties for the api documentation (swagger). For example set property api.title to my cool stuff" },
    "corsHeaders": { "kind": "element", "displayName": "Cors Headers", "required": false, "type": "array", "javaType": "java.util.List<org.apache.camel.model.rest.RestPropertyDefinition>", "deprecated": false, "secret": false, "description": "Allows to configure custom CORS headers." }
  }
}
