@apistudio/apim-cli
Version:
CLI for API Management Products
1,203 lines (1,202 loc) • 54.8 kB
JavaScript
export default {
"rules": {
"invalid-kind-value-combined": {
"description": "Kind must be one of 'API' | 'Scope' | 'Project' | 'StagedPolicySequence' | 'InvokeAWSLambda' | 'ValidateAPISpecification' | 'CORS' | 'Quota' | 'Plan' | 'Product' | 'URISchemes' | 'properties' | 'Telemetry' | 'Properties' | 'LoadBalancer' | 'SetAuthorization' | 'Invoke' | 'GlobalPolicy' | 'InboundBulkHead' | 'SetMediaType' | 'InboundMessaging' | 'IAM' | 'AuthorizeUser' | 'SetContextVariable' | 'WebMethodsISService' | 'Log' | 'MonitorTraffic' | 'CacheServiceResult' | 'OutboundAlias' | 'OutboundAnonymous' | 'HTTPInvoke' | 'InvokeMessagingExtension' | 'DataMasking' | 'TransformRequest' | 'TransformResponse' | 'Route' | 'MessageConfig' | 'HTTPEndpoint' | 'MockEndpoint' | 'MockResponse' | 'ErrorProcessing' | 'Set' | 'RateLimitDef' | 'RateLimit' | 'Redact' | 'Remove' | 'Transform' | 'DataPowerAssembly' | 'Switch' | 'If' | 'OperationSwitch' | 'Try' | 'IBMCloudLogin' | 'WatsonXAIInvoke' | 'OpenAIInvoke' | 'FreeFlowPolicySequence' | 'Block' | 'TokenMediation' | 'EnforceCircuitBreaker' | 'JavaScript' | 'LuaScript' | 'Cache' | 'Antivirus' | 'SQLInjectionFilter' | 'CountLimit' | 'CountLimitDef' | 'Return' | 'Retry' | 'Throw' | 'HandlebarsTemplate' | 'ExtractIdentity' | 'Authorize' | 'Authenticate' | 'Parse' | 'test' | 'assertion' | 'environment' | 'MCPTool' | 'MCPServerConfig'",
"severity": "error",
"given": "$",
"then": {
"field": "kind",
"function": "schema",
"functionOptions": {
"schema": {
"type": "string",
"enum": [
"API",
"Scope",
"Project",
"StagedPolicySequence",
"InvokeAWSLambda",
"ValidateAPISpecification",
"CORS",
"Quota",
"Plan",
"Product",
"URISchemes",
"properties",
"Telemetry",
"Properties",
"LoadBalancer",
"SetAuthorization",
"Invoke",
"GlobalPolicy",
"InboundBulkHead",
"SetMediaType",
"InboundMessaging",
"IAM",
"AuthorizeUser",
"SetContextVariable",
"WebMethodsISService",
"Log",
"MonitorTraffic",
"CacheServiceResult",
"OutboundAlias",
"OutboundAnonymous",
"HTTPInvoke",
"InvokeMessagingExtension",
"DataMasking",
"TransformRequest",
"TransformResponse",
"Route",
"MessageConfig",
"HTTPEndpoint",
"MockEndpoint",
"MockResponse",
"ErrorProcessing",
"Set",
"RateLimitDef",
"RateLimit",
"Redact",
"Remove",
"Transform",
"DataPowerAssembly",
"Switch",
"If",
"OperationSwitch",
"Try",
"IBMCloudLogin",
"WatsonXAIInvoke",
"OpenAIInvoke",
"FreeFlowPolicySequence",
"Block",
"TokenMediation",
"EnforceCircuitBreaker",
"JavaScript",
"LuaScript",
"Cache",
"Antivirus",
"SQLInjectionFilter",
"CountLimit",
"CountLimitDef",
"Return",
"Retry",
"Throw",
"HandlebarsTemplate",
"ExtractIdentity",
"Authorize",
"Authenticate",
"Parse",
"test",
"assertion",
"environment",
"MCPTool",
"MCPServerConfig"
]
}
}
}
},
"kind-not-exist": {
"description": "Kind does not exist.",
"severity": "error",
"given": "$",
"resolved": false,
"then": {
"field": "kind",
"function": "truthy"
}
},
"invalid-kind-value": {
"description": "Kind must be 'Redact'",
"severity": "error",
"given": "$",
"then": {
"field": "kind",
"function": "schema",
"functionOptions": {
"schema": {
"type": "string",
"enum": [
"Redact"
]
}
}
}
},
"invalid-kind-spl-character": {
"description": "kind should not be having empty or special characters",
"severity": "error",
"given": "$",
"resolved": false,
"then": {
"field": "kind",
"function": "pattern",
"functionOptions": {
"match": "^(?![\\s\\W_]+$).+$"
}
}
},
"invalid-api-version": {
"description": "apiVersion must be one of the valid values 'api.ibm.com/v1'",
"severity": "error",
"given": "$",
"resolved": false,
"then": {
"field": "apiVersion",
"function": "schema",
"functionOptions": {
"schema": {
"type": "string",
"enum": [
"api.ibm.com/v1"
]
}
}
}
},
"api-version-not-exist": {
"description": "apiVersion does not exist.",
"severity": "error",
"given": "$",
"resolved": false,
"then": {
"field": "apiVersion",
"function": "truthy"
}
},
"metadata-not-exist": {
"description": "Metadata does not exist.",
"severity": "error",
"given": "$",
"resolved": false,
"then": {
"field": "metadata",
"function": "truthy"
}
},
"metadata-whitelist-check": {
"description": "Metadata should not be having empty or special characters",
"severity": "error",
"given": "$",
"resolved": false,
"then": {
"field": "metadata",
"function": "pattern",
"functionOptions": {
"match": "^(?![\\s\\W_]+$).+$"
}
}
},
"metadata-name-not-exist": {
"description": "Metadata name does not exist",
"severity": "error",
"given": "$.metadata",
"resolved": false,
"then": {
"field": "name",
"function": "truthy"
}
},
"metadata-name-whitelist-check": {
"description": "Metadata name should not be having empty or special characters",
"severity": "error",
"given": "$.metadata",
"resolved": false,
"then": {
"field": "name",
"function": "pattern",
"functionOptions": {
"match": "^(?![\\s\\W_]+$).+$"
}
}
},
"metadata-version-not-exist": {
"description": "Metadata version does not exist",
"severity": "error",
"given": "$.metadata",
"resolved": false,
"then": {
"field": "version",
"function": "truthy"
}
},
"metadata-version-whitelist-check": {
"description": "Metadata version should not be having empty or special characters",
"severity": "error",
"given": "$.metadata",
"resolved": false,
"then": {
"field": "version",
"function": "pattern",
"functionOptions": {
"match": "^(?![\\s\\W_]+$).+$"
}
}
},
"metadata-namespace-not-exist": {
"description": "Metadata namespace does not exist",
"severity": "warn",
"given": "$.metadata",
"resolved": false,
"then": {
"field": "namespace",
"function": "truthy"
}
},
"metadata-namespace-whitelist-check": {
"description": "Metadata namespace should not be having empty or special characters",
"severity": "warn",
"given": "$.metadata",
"resolved": false,
"then": {
"field": "namespace",
"function": "pattern",
"functionOptions": {
"match": "^(?![\\s\\W_]+$).+$"
}
}
},
"spec-details-not-exist": {
"description": "Spec details does not exist",
"severity": "error",
"given": "$",
"resolved": false,
"then": {
"field": "spec",
"function": "truthy"
}
},
"spec-details-whitelist-check": {
"description": "Spec should not be having empty or special characters",
"severity": "error",
"given": "$",
"resolved": false,
"then": {
"field": "spec",
"function": "pattern",
"functionOptions": {
"match": "^(?![\\s\\W_]+$).+$"
}
}
},
"tags-not-exist": {
"description": "Tag does not exist",
"severity": "warn",
"given": "$.metadata",
"resolved": false,
"then": {
"field": "tags",
"function": "truthy"
}
},
"invalid-tag-type": {
"description": "Invalid Tag Type",
"severity": "error",
"given": "$.metadata.tags",
"resolved": false,
"then": {
"function": "schema",
"functionOptions": {
"schema": {
"type": "array"
}
}
}
},
"$-metadata-description-type": {
"description": "The description field must be of type string",
"severity": "error",
"given": "$.metadata.description",
"then": {
"function": "schema",
"functionOptions": {
"schema": {
"type": "string"
}
}
}
},
"$-metadata-name-required": {
"description": "The name field is required in the $.metadata",
"severity": "error",
"given": "$.metadata",
"then": {
"field": "name",
"function": "defined"
}
},
"$-metadata-name-type": {
"description": "The name field must be of type string",
"severity": "error",
"given": "$.metadata.name",
"then": {
"function": "schema",
"functionOptions": {
"schema": {
"type": "string"
}
}
}
},
"$-metadata-namespace-type": {
"description": "The namespace field must be of type string",
"severity": "error",
"given": "$.metadata.namespace",
"then": {
"function": "schema",
"functionOptions": {
"schema": {
"type": "string"
}
}
}
},
"$-metadata-tags-type": {
"description": "The tags field must be of type array",
"severity": "error",
"given": "$.metadata.tags",
"then": {
"function": "schema",
"functionOptions": {
"schema": {
"type": "array"
}
}
}
},
"$-metadata-tags-items-type": {
"description": "Items in the tags array must be of type string",
"severity": "error",
"given": "$.metadata.tags[*]",
"then": {
"function": "schema",
"functionOptions": {
"schema": {
"type": "string"
}
}
}
},
"$-metadata-type-type": {
"description": "The type field must be of type string",
"severity": "error",
"given": "$.metadata.type",
"then": {
"function": "schema",
"functionOptions": {
"schema": {
"type": "string"
}
}
}
},
"$-metadata-type-enum": {
"description": "The type field must be one of: REST, SWAGGER, SOAP, GRAPHQL, ODATA",
"severity": "error",
"given": "$.metadata.type",
"then": {
"function": "schema",
"functionOptions": {
"schema": {
"enum": [
"REST",
"SWAGGER",
"SOAP",
"GRAPHQL",
"ODATA"
]
}
}
}
},
"$-metadata-version-required": {
"description": "The version field is required in the $.metadata",
"severity": "error",
"given": "$.metadata",
"then": {
"field": "version",
"function": "defined"
}
},
"$-metadata-version-type": {
"description": "The version field must be of type string",
"severity": "error",
"given": "$.metadata.version",
"then": {
"function": "schema",
"functionOptions": {
"schema": {
"type": "string"
}
}
}
},
"$-metadata-labels-type": {
"description": "The labels field must be of type object",
"severity": "error",
"given": "$.metadata.labels",
"then": {
"function": "schema",
"functionOptions": {
"schema": {
"type": "object"
}
}
}
},
"$-metadata-labels-gatewayTypes-type": {
"description": "The gatewayTypes field must be of type array",
"severity": "error",
"given": "$.metadata.labels.gatewayTypes",
"then": {
"function": "schema",
"functionOptions": {
"schema": {
"type": "array"
}
}
}
},
"$-metadata-labels-gatewayTypes-items-type": {
"description": "Items in the gatewayTypes array must be of type string",
"severity": "error",
"given": "$.metadata.labels.gatewayTypes[*]",
"then": {
"function": "schema",
"functionOptions": {
"schema": {
"type": "string"
}
}
}
},
"spec-oneOf": {
"description": "The spec field must match the oneOf schema definition",
"severity": "error",
"given": "$.spec",
"then": {
"function": "schema",
"functionOptions": {
"schema": {
"oneOf": [
{
"type": "object",
"required": [
"message"
],
"additionalProperties": false,
"properties": {
"message": {
"type": "object",
"required": [
"messageName"
],
"additionalProperties": false,
"properties": {
"messageName": {
"type": "string"
},
"queryParameters": {
"type": "array",
"items": {
"type": "string"
}
},
"headers": {
"type": "array",
"items": {
"type": "string"
}
},
"body": {
"type": "object",
"required": [
"captures"
],
"additionalProperties": false,
"properties": {
"captures": {
"oneOf": [
{
"type": "object",
"required": [
"jsonata"
],
"additionalProperties": false,
"properties": {
"jsonata": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
{
"type": "object",
"required": [
"regex"
],
"additionalProperties": false,
"properties": {
"regex": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
]
}
}
}
}
}
}
},
{
"type": "object",
"required": [
"variable"
],
"additionalProperties": false,
"properties": {
"variable": {
"type": "object",
"required": [
"name",
"captures"
],
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"captures": {
"oneOf": [
{
"type": "object",
"required": [
"jsonata"
],
"additionalProperties": false,
"properties": {
"jsonata": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
{
"type": "object",
"required": [
"regex"
],
"additionalProperties": false,
"properties": {
"regex": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
]
}
}
}
}
},
{
"type": "object",
"required": [
"distributedVariable"
],
"additionalProperties": false,
"properties": {
"distributedVariable": {
"type": "object",
"required": [
"name",
"captures"
],
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"captures": {
"oneOf": [
{
"type": "object",
"required": [
"jsonata"
],
"additionalProperties": false,
"properties": {
"jsonata": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
{
"type": "object",
"required": [
"regex"
],
"additionalProperties": false,
"properties": {
"regex": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
]
}
}
}
}
},
{
"type": "object",
"required": [
"telemetry"
],
"additionalProperties": false,
"properties": {
"telemetry": {
"type": "object",
"required": [
"keys",
"span"
],
"additionalProperties": false,
"properties": {
"keys": {
"type": "array",
"items": {
"type": "string"
}
},
"span": {
"description": "Supports rootSpan (string) or structured spans.",
"oneOf": [
{
"type": "string",
"enum": [
"rootSpan"
]
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"policySpan": {
"type": "string"
},
"httpSpan": {
"type": "string"
}
}
}
]
}
}
}
}
}
]
}
}
}
},
"spec-message-type": {
"description": "The spec.message field must be of type object",
"severity": "error",
"given": "$.spec.message",
"then": {
"function": "schema",
"functionOptions": {
"schema": {
"type": "object"
}
}
}
},
"spec-message-no-additional-properties": {
"description": "The spec.message field must be an object with no additional properties",
"severity": "error",
"given": "$.spec.message",
"then": {
"function": "schema",
"functionOptions": {
"schema": {
"type": "object",
"additionalProperties": false,
"properties": {
"messageName": {},
"queryParameters": {},
"headers": {},
"body": {}
}
}
}
}
},
"$-spec-message-messageName-type": {
"description": "The messageName field must be of type string",
"severity": "error",
"given": "$.spec.message.messageName",
"then": {
"function": "schema",
"functionOptions": {
"schema": {
"type": "string"
}
}
}
},
"$-spec-message-queryParameters-type": {
"description": "The queryParameters field must be of type array",
"severity": "error",
"given": "$.spec.message.queryParameters",
"then": {
"function": "schema",
"functionOptions": {
"schema": {
"type": "array"
}
}
}
},
"$-spec-message-queryParameters-items-type": {
"description": "Items in the queryParameters array must be of type string",
"severity": "error",
"given": "$.spec.message.queryParameters[*]",
"then": {
"function": "schema",
"functionOptions": {
"schema": {
"type": "string"
}
}
}
},
"$-spec-message-headers-type": {
"description": "The headers field must be of type array",
"severity": "error",
"given": "$.spec.message.headers",
"then": {
"function": "schema",
"functionOptions": {
"schema": {
"type": "array"
}
}
}
},
"$-spec-message-headers-items-type": {
"description": "Items in the headers array must be of type string",
"severity": "error",
"given": "$.spec.message.headers[*]",
"then": {
"function": "schema",
"functionOptions": {
"schema": {
"type": "string"
}
}
}
},
"$-spec-message-body-type": {
"description": "The body field must be of type object",
"severity": "error",
"given": "$.spec.message.body",
"then": {
"function": "schema",
"functionOptions": {
"schema": {
"type": "object"
}
}
}
},
"$-spec-message-body-captures-oneOf": {
"description": "The captures field must match the oneOf schema definition",
"severity": "error",
"given": "$.spec.message.body.captures",
"then": {
"function": "schema",
"functionOptions": {
"schema": {
"oneOf": [
{
"type": "object",
"required": [
"jsonata"
],
"additionalProperties": false,
"properties": {
"jsonata": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
{
"type": "object",
"required": [
"regex"
],
"additionalProperties": false,
"properties": {
"regex": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
]
}
}
}
},
"$-spec-message-body-captures-jsonata-type": {
"description": "The jsonata field must be of type array",
"severity": "error",
"given": "$.spec.message.body.captures.jsonata",
"then": {
"function": "schema",
"functionOptions": {
"schema": {
"type": "array"
}
}
}
},
"$-spec-message-body-captures-jsonata-items-type": {
"description": "Items in the jsonata array must be of type string",
"severity": "error",
"given": "$.spec.message.body.captures.jsonata[*]",
"then": {
"function": "schema",
"functionOptions": {
"schema": {
"type": "string"
}
}
}
},
"$-spec-message-body-captures-regex-type": {
"description": "The regex field must be of type array",
"severity": "error",
"given": "$.spec.message.body.captures.regex",
"then": {
"function": "schema",
"functionOptions": {
"schema": {
"type": "array"
}
}
}
},
"$-spec-message-body-captures-regex-items-type": {
"description": "Items in the regex array must be of type string",
"severity": "error",
"given": "$.spec.message.body.captures.regex[*]",
"then": {
"function": "schema",
"functionOptions": {
"schema": {
"type": "string"
}
}
}
},
"$-spec-message-body-no-additional-properties": {
"description": "The body object should only contain the defined properties: captures",
"severity": "error",
"given": "$.spec.message.body",
"then": {
"function": "schema",
"functionOptions": {
"schema": {
"additionalProperties": false,
"properties": {
"captures": {}
}
}
}
}
},
"spec-variable-type": {
"description": "The spec.variable field must be of type object",
"severity": "error",
"given": "$.spec.variable",
"then": {
"function": "schema",
"functionOptions": {
"schema": {
"type": "object"
}
}
}
},
"spec-variable-no-additional-properties": {
"description": "The spec.variable field must be an object with no additional properties",
"severity": "error",
"given": "$.spec.variable",
"then": {
"function": "schema",
"functionOptions": {
"schema": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {},
"captures": {}
}
}
}
}
},
"$-spec-variable-name-type": {
"description": "The name field must be of type string",
"severity": "error",
"given": "$.spec.variable.name",
"then": {
"function": "schema",
"functionOptions": {
"schema": {
"type": "string"
}
}
}
},
"$-spec-variable-captures-oneOf": {
"description": "The captures field must match the oneOf schema definition",
"severity": "error",
"given": "$.spec.variable.captures",
"then": {
"function": "schema",
"functionOptions": {
"schema": {
"oneOf": [
{
"type": "object",
"required": [
"jsonata"
],
"additionalProperties": false,
"properties": {
"jsonata": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
{
"type": "object",
"required": [
"regex"
],
"additionalProperties": false,
"properties": {
"regex": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
]
}
}
}
},
"$-spec-variable-captures-jsonata-type": {
"description": "The jsonata field must be of type array",
"severity": "error",
"given": "$.spec.variable.captures.jsonata",
"then": {
"function": "schema",
"functionOptions": {
"schema": {
"type": "array"
}
}
}
},
"$-spec-variable-captures-jsonata-items-type": {
"description": "Items in the jsonata array must be of type string",
"severity": "error",
"given": "$.spec.variable.captures.jsonata[*]",
"then": {
"function": "schema",
"functionOptions": {
"schema": {
"type": "string"
}
}
}
},
"$-spec-variable-captures-regex-type": {
"description": "The regex field must be of type array",
"severity": "error",
"given": "$.spec.variable.captures.regex",
"then": {
"function": "schema",
"functionOptions": {
"schema": {
"type": "array"
}
}
}
},
"$-spec-variable-captures-regex-items-type": {
"description": "Items in the regex array must be of type string",
"severity": "error",
"given": "$.spec.variable.captures.regex[*]",
"then": {
"function": "schema",
"functionOptions": {
"schema": {
"type": "string"
}
}
}
},
"spec-distributedVariable-type": {
"description": "The spec.distributedVariable field must be of type object",
"severity": "error",
"given": "$.spec.distributedVariable",
"then": {
"function": "schema",
"functionOptions": {
"schema": {
"type": "object"
}
}
}
},
"spec-distributedVariable-no-additional-properties": {
"description": "The spec.distributedVariable field must be an object with no additional properties",
"severity": "error",
"given": "$.spec.distributedVariable",
"then": {
"function": "schema",
"functionOptions": {
"schema": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {},
"captures": {}
}
}
}
}
},
"$-spec-distributedVariable-name-type": {
"description": "The name field must be of type string",
"severity": "error",
"given": "$.spec.distributedVariable.name",
"then": {
"function": "schema",
"functionOptions": {
"schema": {
"type": "string"
}
}
}
},
"$-spec-distributedVariable-captures-oneOf": {
"description": "The captures field must match the oneOf schema definition",
"severity": "error",
"given": "$.spec.distributedVariable.captures",
"then": {
"function": "schema",
"functionOptions": {
"schema": {
"oneOf": [
{
"type": "object",
"required": [
"jsonata"
],
"additionalProperties": false,
"properties": {
"jsonata": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
{
"type": "object",
"required": [
"regex"
],
"additionalProperties": false,
"properties": {
"regex": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
]
}
}
}
},
"$-spec-distributedVariable-captures-jsonata-type": {
"description": "The jsonata field must be of type array",
"severity": "error",
"given": "$.spec.distributedVariable.captures.jsonata",
"then": {
"function": "schema",
"functionOptions": {
"schema": {
"type": "array"
}
}
}
},
"$-spec-distributedVariable-captures-jsonata-items-type": {
"description": "Items in the jsonata array must be of type string",
"severity": "error",
"given": "$.spec.distributedVariable.captures.jsonata[*]",
"then": {
"function": "schema",
"functionOptions": {
"schema": {
"type": "string"
}
}
}
},
"$-spec-distributedVariable-captures-regex-type": {
"description": "The regex field must be of type array",
"severity": "error",
"given": "$.spec.distributedVariable.captures.regex",