ProxyRequest

Estrutura de dados do contrato OpenAPI.

Estrutura de dados do contrato OpenAPI.

Campos

CampoTipoPresençaDescrição
modestringobrigatórioValores: "custom", "none", "internal"
proxy_urlstringcondicionalObrigatória em custom; http/https/socks5/socks5h; sondada antes da gravação. Somente na requisição; não é devolvido
confirm_no_proxybooleancondicionalObrigatório true em mode=none.

Quando mode = "custom", informe proxy_url.

Quando mode = "none", informe confirm_no_proxy.

Definição OpenAPI

json
{
  "type": "object",
  "properties": {
    "mode": {
      "type": "string",
      "enum": [
        "custom",
        "none",
        "internal"
      ]
    },
    "proxy_url": {
      "type": "string",
      "description": "Obrigatória em custom; http/https/socks5/socks5h; sondada antes da gravação.",
      "writeOnly": true
    },
    "confirm_no_proxy": {
      "type": "boolean",
      "description": "Obrigatório true em mode=none."
    }
  },
  "required": [
    "mode"
  ],
  "allOf": [
    {
      "if": {
        "properties": {
          "mode": {
            "const": "custom"
          }
        }
      },
      "then": {
        "required": [
          "proxy_url"
        ]
      }
    },
    {
      "if": {
        "properties": {
          "mode": {
            "const": "none"
          }
        }
      },
      "then": {
        "required": [
          "confirm_no_proxy"
        ],
        "properties": {
          "confirm_no_proxy": {
            "const": true
          }
        }
      }
    }
  ]
}