rulesets_LogCustomFieldRule

APIs.ioEngineeringPlatform
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-rulesets-logcustomfieldrule-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/rulesets_LogCustomFieldRule",
  "title": "rulesets_LogCustomFieldRule",
  "allOf": [
    {
      "$ref": "#/components/schemas/rulesets_Rule"
    },
    {
      "properties": {
        "action": {
          "enum": [
            "log_custom_field"
          ]
        },
        "action_parameters": {
          "minProperties": 1,
          "properties": {
            "cookie_fields": {
              "description": "The cookie fields to log.",
              "example": [
                {
                  "name": "cookie_name_1"
                }
              ],
              "items": {
                "description": "The cookie field to log.",
                "properties": {
                  "name": {
                    "description": "The name of the field.",
                    "example": "cookie_name_1",
                    "minLength": 1,
                    "title": "Name",
                    "type": "string"
                  }
                },
                "required": [
                  "name"
                ],
                "title": "Cookie field",
                "type": "object"
              },
              "minItems": 1,
              "title": "Cookie fields",
              "type": "array"
            },
            "request_fields": {
              "description": "The request fields to log.",
              "example": [
                {
                  "name": "http_request_header_name_1_in_lower_case"
                }
              ],
              "items": {
                "description": "The request field to log.",
                "properties": {
                  "name": {
                    "description": "The name of the field.",
                    "example": "http_request_header_name_1_in_lower_case",
                    "minLength": 1,
                    "title": "Name",
                    "type": "string"
                  }
                },
                "required": [
                  "name"
                ],
                "title": "Request field",
                "type": "object"
              },
              "minItems": 1,
              "title": "Request fields",
              "type": "array"
            },
            "response_fields": {
              "description": "The response fields to log.",
              "example": [
                {
                  "name": "http_response_header_name_1_in_lower_case"
                }
              ],
              "items": {
                "description": "The response field to log.",
                "properties": {
                  "name": {
                    "description": "The name of the field.",
                    "example": "http_response_header_name_1_in_lower_case",
                    "minLength": 1,
                    "title": "Name",
                    "type": "string"
                  }
                },
                "required": [
                  "name"
                ],
                "title": "Response field",
                "type": "object"
              },
              "minItems": 1,
              "title": "Response fields",
              "type": "array"
            }
          }
        },
        "description": {
          "example": "Log custom field when the IP address is not 1.1.1.1"
        }
      },
      "title": "Log Custom Field rule"
    }
  ]
}