schemas.schema-form.json Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gravitee-resource-auth-provider-http Show documentation

Gravitee.io HTTP Authentication Provider resource is used to validate user's credentials against an HTTP server.

The newest version!

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "method": {
      "title": "HTTP Method",
      "description": "HTTP method to invoke the endpoint.",
      "type": "string",
      "default": "POST",
      "enum": [
        "GET",
        "POST",
        "PUT",
        "DELETE",
        "PATCH",
        "HEAD",
        "CONNECT",
        "OPTIONS",
        "TRACE"
      ]
    },
    "useSystemProxy": {
      "title": "Use system proxy",
      "description": "Use the system proxy configured by your administrator.",
      "type": "boolean"
    },
    "url": {
      "title": "URL",
      "description": "Server url",
      "type": "string"
    },
    "headers": {
      "type": "array",
      "title": "Request Headers",
      "description": "Header value support EL",
      "items": {
        "type": "object",
        "title": "Header",
        "properties": {
          "name": {
            "title": "Name",
            "type": "string"
          },
          "value": {
            "title": "Value (support EL)",
            "type": "string",
            "x-schema-form": {
              "expression-language": true
            }
          }
        }
      },
      "required": [
        "name",
        "value"
      ],
      "gioConfig": {
        "uiType": "gio-headers-array"
      }
    },
    "body": {
      "title": "Request body (support EL)",
      "type": "string",
      "format": "gio-code-editor",
      "x-schema-form": {
        "type": "codemirror",
        "codemirrorOptions": {
          "placeholder": "Put request body here",
          "lineWrapping": true,
          "lineNumbers": true,
          "allowDropFileTypes": true,
          "autoCloseTags": true
        },
        "expression-language": true
      }
    },
    "condition": {
      "title": "Authentication condition",
      "description": "The condition which will be verified to validate that the authentication is successful (support EL).",
      "default": "{#authResponse.status == 200}",
      "type": "string",
      "x-schema-form": {
        "expression-language": true
      }
    }
  },
  "required": [
    "method",
    "url",
    "condition"
  ]
}