META-INF.spring-configuration-metadata.json Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of spring-boot-starter-core Show documentation
OpenAPI Spec Validation
The newest version!
{
  "properties": [
    {
      "name": "openapi.validation.sample-rate",
      "type": "java.lang.Double",
      "description": "Amount of traffic to be validated. Defaults to 0.001."
    },
    {
      "name": "openapi.validation.specification-file-path",
      "type": "java.lang.String",
      "description": "Path to the OpenAPI specification file. If set, the system will search for this file within resources and also as a path based on the current (working) directory. The property defaults to null. If null, the program searches for either an 'openapi.yaml/json' or a 'spec.yaml/json' file under resources."
    },
    {
      "name": "openapi.validation.violation-log-level",
      "type": "com.getyourguide.openapi.validation.api.log.LogLevel",
      "description": "Log level to be used for all violations. Default: info\nNote: This has no effect if a custom ValidatorConfiguration is provided, then it needs to be configured there."
    },
    {
      "name": "openapi.validation.excluded-paths",
      "type": "java.lang.String",
      "description": "Comma separated list of paths to be excluded from validation. Default is no excluded paths."
    },
    {
      "name": "openapi.validation.excluded-headers",
      "type": "java.util.List",
      "description": "Headers with patterns to be excluded. e.g. `User-Agent: .*(bingbot|googlebot).*`. Default is no excluded paths."
    },
    {
      "name": "openapi.validation.validation-report-throttle-wait-seconds",
      "type": "java.lang.Integer",
      "description": "Number of seconds for which the validation report throttler will wait before sending the next report. The property defaults to null. If null or 0, there won't be any throttling."
    },
    {
      "name": "openapi.validation.validation-report-metric-name",
      "type": "java.lang.String",
      "description": "Metric name to be used when reporting violations with the MetricsReporter. The property defaults to 'openapi.validation'."
    },
    {
      "name": "openapi.validation.validation-report-metric-additional-tags",
      "type": "java.lang.String",
      "description": "Additional tags to be logged with metrics. They should be in the format {KEY}={VALUE},{KEY}={VALUE}. Default is no additional tags."
    },
    {
      "name": "openapi.validation.should-fail-on-request-violation",
      "type": "java.lang.Boolean",
      "description": "If set to true the request will fail in case a request violation occurs. Defaults to false."
    },
    {
      "name": "openapi.validation.should-fail-on-response-violation",
      "type": "java.lang.Boolean",
      "description": "If set to true the request will fail in case a response violation occurs. Defaults to false."
    }
  ]
}