API ManagementGatewaysOpen-SourceAPI LifecycleGraphQLSOAPREST
RuleValidationResult is a JSON Structure definition published by WSO2, describing 7 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.
{
"$schema": "https://json-structure.org/meta/core/v0/#",
"$id": "https://raw.githubusercontent.com/api-evangelist/wso2/refs/heads/main/json-structure/governance-api-rule-validation-result-structure.json",
"name": "RuleValidationResult",
"description": "Result of the rule validation.",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "UUID of the rule.",
"example": "123e4567-e89b-12d3-a456-426614174000"
},
"name": {
"type": "string",
"description": "Name of the rule.",
"example": "API Name Rule"
},
"status": {
"type": "string",
"description": "Status of the rule validation.",
"enum": [
"PASSED",
"FAILED"
],
"example": "FAILED"
},
"severity": {
"type": "string",
"description": "Severity level of the rule violation.",
"enum": [
"ERROR",
"WARN",
"INFO"
],
"example": "WARN"
},
"violatedPath": {
"type": "object",
"description": "Path in the artifact where the rule is violated.",
"properties": {
"path": {
"type": "string",
"description": "Path in the artifact where the rule is violated.",
"example": "info.title"
},
"description": {
"type": "string",
"description": "Description of the path.",
"example": "API name"
}
}
},
"message": {
"type": "string",
"description": "Message to be displayed when the rule is violated.",
"example": "API name can not be too long or short"
},
"description": {
"type": "string",
"description": "Description of the rule.",
"example": "API name should be between 5 to 50 characters"
}
}
}
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.