WSO2 · Schema

OperationPolicySpecAttribute

OperationPolicySpecAttribute schema from WSO2 API Manager

API ManagementGatewaysOpen SourceAPI LifecycleGraphQLSOAPREST

Properties

Name Type Description
name string Name of the attibute
displayName string Display name of the attibute
description string Description of the attibute
validationRegex string UI validation regex for the attibute
type string Type of the attibute
required boolean Is this attibute mandetory for the policy
defaultValue string Default value for the attribute
allowedValues array If the attribute type is enum, this array should contain all the possible values for the enum.
View JSON Schema on GitHub

JSON Schema

publisher-api-operation-policy-spec-attribute-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/wso2/refs/heads/main/json-schema/publisher-api-operation-policy-spec-attribute-schema.json",
  "title": "OperationPolicySpecAttribute",
  "description": "OperationPolicySpecAttribute schema from WSO2 API Manager",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "Name of the attibute",
      "example": "headerName"
    },
    "displayName": {
      "type": "string",
      "description": "Display name of the attibute",
      "example": "Header Name"
    },
    "description": {
      "type": "string",
      "description": "Description of the attibute",
      "example": "Name of the header to be removed"
    },
    "validationRegex": {
      "type": "string",
      "description": "UI validation regex for the attibute",
      "example": "/^[a-z\\s]{0,255}$/i"
    },
    "type": {
      "type": "string",
      "description": "Type of the attibute",
      "example": "string"
    },
    "required": {
      "type": "boolean",
      "description": "Is this attibute mandetory for the policy",
      "example": true
    },
    "defaultValue": {
      "type": "string",
      "description": "Default value for the attribute",
      "example": true
    },
    "allowedValues": {
      "type": "array",
      "description": "If the attribute type is enum, this array should contain all the possible values for the enum.",
      "items": {
        "type": "string",
        "example": [
          "GET",
          "POST",
          "PUT"
        ]
      }
    }
  }
}