vrl 0.32.0

Vector Remap Language
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73

{
  "anchor": "validate_json_schema",
  "name": "validate_json_schema",
  "category": "Type",
  "description": "Check if `value` conforms to a JSON Schema definition. This function validates a JSON payload against a JSON Schema definition. It can be used to ensure that the data structure and types in `value` match the expectations defined in `schema_definition`.",
  "arguments": [
    {
      "name": "value",
      "description": "The value to check if it conforms to the JSON schema definition.",
      "required": true,
      "type": [
        "string"
      ]
    },
    {
      "name": "schema_definition",
      "description": "The location (path) of the JSON Schema definition.",
      "required": true,
      "type": [
        "string"
      ]
    },
    {
      "name": "ignore_unknown_formats",
      "description": "Unknown formats can be silently ignored by setting this to `true` and validation continues without failing due to those fields.",
      "required": false,
      "type": [
        "boolean"
      ]
    }
  ],
  "return": {
    "types": [
      "boolean"
    ],
    "rules": [
      "Returns `true` if `value` conforms to the JSON Schema definition.",
      "Returns `false` if `value` does not conform to the JSON Schema definition."
    ]
  },
  "internal_failure_reasons": [
    "`value` is not a valid JSON Schema payload.",
    "`value` contains custom format declarations and `ignore_unknown_formats` has not been set to `true`.",
    "`schema_definition` is not a valid JSON Schema definition.",
    "`schema_definition` file does not exist."
  ],
  "examples": [
    {
      "title": "Payload contains a valid email",
      "source": "validate_json_schema!(s'{ \"productUser\": \"valid@email.com\" }', \"tests/data/jsonschema/validate_json_schema/schema_with_email_format.json\", false)",
      "return": true
    },
    {
      "title": "Payload contains an invalid email",
      "source": "validate_json_schema!(s'{ \"productUser\": \"invalidEmail\" }', \"tests/data/jsonschema/validate_json_schema/schema_with_email_format.json\", false)",
      "raises": "function call error for \"validate_json_schema\" at (0:142): JSON schema validation failed: \"invalidEmail\" is not a \"email\" at /productUser"
    },
    {
      "title": "Payload contains a custom format declaration",
      "source": "validate_json_schema!(s'{ \"productUser\": \"a-custom-formatted-string\" }', \"tests/data/jsonschema/validate_json_schema/schema_with_custom_format.json\", false)",
      "raises": "function call error for \"validate_json_schema\" at (0:156): Failed to compile schema: Unknown format: 'my-custom-format'. Adjust configuration to ignore unrecognized formats"
    },
    {
      "title": "Payload contains a custom format declaration, with ignore_unknown_formats set to true",
      "source": "validate_json_schema!(s'{ \"productUser\": \"a-custom-formatted-string\" }', \"tests/data/jsonschema/validate_json_schema/schema_with_custom_format.json\", true)",
      "return": true
    }
  ],
  "notices": [
    "This function uses a compiled schema cache. The first time it is called with a specific\n`schema_definition`, it will compile the schema and cache it for subsequent calls. This\nimproves performance when validating multiple values against the same schema. The cache\nimplementation is fairly naive and does not support refreshing the schema if it changes.\nIf you update the schema definition file, you must restart Vector to clear the cache."
  ],
  "pure": true
}