@apistudio/apim-cli
Version:
CLI for API Management Products
1,254 lines (1,253 loc) • 52.9 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 'Set'",
"severity": "error",
"given": "$",
"then": {
"field": "kind",
"function": "schema",
"functionOptions": {
"schema": {
"type": "string",
"enum": [
"Set"
]
}
}
}
},
"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": [
{
"required": [
"messageHeader"
],
"properties": {
"messageHeader": {
"type": "object",
"required": [
"action",
"headerName",
"value",
"messageName"
],
"properties": {
"action": {
"type": "string",
"enum": [
"set",
"add",
"combine"
]
},
"headerName": {
"type": "string"
},
"value": {
"type": "string"
},
"messageName": {
"type": "string"
}
}
},
"valueType": {
"type": "string",
"enum": [
"webm-var-expression",
"plain",
"variables",
"jsonata",
"distributedVariable"
]
}
}
},
{
"required": [
"messageBody"
],
"properties": {
"messageBody": {
"type": "object",
"required": [
"messageName",
"value"
],
"properties": {
"messageName": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"valueType": {
"type": "string",
"enum": [
"plain",
"variables",
"jsonata",
"distributedVariable"
]
}
}
},
{
"required": [
"messageMethod"
],
"properties": {
"messageMethod": {
"type": "object",
"required": [
"messageName",
"method"
],
"properties": {
"messageName": {
"type": "string"
},
"method": {
"type": "string"
}
}
},
"valueType": {
"type": "string",
"enum": [
"plain",
"variables",
"jsonata",
"distributedVariable"
]
}
}
},
{
"required": [
"messageUri"
],
"properties": {
"messageUri": {
"type": "object",
"required": [
"messageName",
"nameType",
"path",
"queryParams"
],
"properties": {
"messageName": {
"type": "string"
},
"nameType": {
"type": "string",
"enum": [
"plain",
"variables",
"jsonata",
"distributedVariable"
]
},
"path": {
"type": "string"
},
"queryParams": {
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"value"
],
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
}
}
},
"valueType": {
"type": "string",
"enum": [
"plain",
"variables",
"jsonata",
"distributedVariable"
]
}
}
},
{
"required": [
"variable"
],
"properties": {
"variable": {
"type": "object",
"required": [
"name",
"value"
],
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"valueType": {
"type": "string",
"enum": [
"plain",
"variables",
"jsonata",
"distributedVariable"
]
}
}
},
{
"required": [
"distributedVariable"
],
"properties": {
"distributedVariable": {
"type": "object",
"required": [
"expire",
"name",
"setExclusive",
"value"
],
"properties": {
"expire": {
"type": "integer"
},
"name": {
"type": "string"
},
"setExclusive": {
"type": "boolean"
},
"value": {
"type": "string"
}
}
},
"valueType": {
"type": "string",
"enum": [
"plain",
"variables",
"jsonata",
"distributedVariable"
]
}
}
},
{
"required": [
"telemetry",
"valueType"
],
"additionalProperties": false,
"properties": {
"telemetry": {
"type": "object",
"required": [
"key",
"span",
"value"
],
"additionalProperties": false,
"properties": {
"key": {
"type": "string"
},
"span": {
"oneOf": [
{
"type": "string"
},
{
"type": "object",
"oneOf": [
{
"required": [
"policySpan"
],
"properties": {
"policySpan": {
"type": "string"
}
}
},
{
"required": [
"httpSpan"
],
"properties": {
"httpSpan": {
"type": "string"
}
}
}
]
}
]
},
"value": {
"type": "string"
}
}
},
"valueType": {
"type": "string",
"enum": [
"plain",
"variables",
"jsonata",
"distributedVariable"
]
}
}
}
]
}
}
}
},
"spec-messageHeader-type": {
"description": "The spec.messageHeader field must be of type object",
"severity": "error",
"given": "$.spec.messageHeader",
"then": {
"function": "schema",
"functionOptions": {
"schema": {
"type": "object"
}
}
}
},
"$-spec-messageHeader-action-type": {
"description": "The action field must be of type string",
"severity": "error",
"given": "$.spec.messageHeader.action",
"then": {
"function": "schema",
"functionOptions": {
"schema": {
"type": "string"
}
}
}
},
"$-spec-messageHeader-action-enum": {
"description": "The action field must be one of: set, add, combine",
"severity": "error",
"given": "$.spec.messageHeader.action",
"then": {
"function": "schema",
"functionOptions": {
"schema": {
"enum": [
"set",
"add",
"combine"
]
}
}
}
},
"$-spec-messageHeader-headerName-type": {
"description": "The headerName field must be of type string",
"severity": "error",
"given": "$.spec.messageHeader.headerName",
"then": {
"function": "schema",
"functionOptions": {
"schema": {
"type": "string"
}
}
}
},
"$-spec-messageHeader-value-type": {
"description": "The value field must be of type string",
"severity": "error",
"given": "$.spec.messageHeader.value",
"then": {
"function": "schema",
"functionOptions": {
"schema": {
"type": "string"
}
}
}
},
"$-spec-messageHeader-messageName-type": {
"description": "The messageName field must be of type string",
"severity": "error",
"given": "$.spec.messageHeader.messageName",
"then": {
"function": "schema",
"functionOptions": {
"schema": {
"type": "string"
}
}
}
},
"spec-valueType-type": {
"description": "The spec.valueType field must be of type string",
"severity": "error",
"given": "$.spec.valueType",
"then": {
"function": "schema",
"functionOptions": {
"schema": {
"type": "string"
}
}
}
},
"spec-messageBody-type": {
"description": "The spec.messageBody field must be of type object",
"severity": "error",
"given": "$.spec.messageBody",
"then": {
"function": "schema",
"functionOptions": {
"schema": {
"type": "object"
}
}
}
},
"$-spec-messageBody-messageName-type": {
"description": "The messageName field must be of type string",
"severity": "error",
"given": "$.spec.messageBody.messageName",
"then": {
"function": "schema",
"functionOptions": {
"schema": {
"type": "string"
}
}
}
},
"$-spec-messageBody-value-type": {
"description": "The value field must be of type string",
"severity": "error",
"given": "$.spec.messageBody.value",
"then": {
"function": "schema",
"functionOptions": {
"schema": {
"type": "string"
}
}
}
},
"spec-messageMethod-type": {
"description": "The spec.messageMethod field must be of type object",
"severity": "error",
"given": "$.spec.messageMethod",
"then": {
"function": "schema",
"functionOptions": {
"schema": {
"type": "object"
}
}
}
},
"$-spec-messageMethod-messageName-type": {
"description": "The messageName field must be of type string",
"severity": "error",
"given": "$.spec.messageMethod.messageName",
"then": {
"function": "schema",
"functionOptions": {
"schema": {
"type": "string"
}
}
}
},
"$-spec-messageMethod-method-type": {
"description": "The method field must be of type string",
"severity": "error",
"given": "$.spec.messageMethod.method",
"then": {
"function": "schema",
"functionOptions": {
"schema": {
"type": "string"
}
}
}
},
"spec-messageUri-type": {
"description": "The spec.messageUri field must be of type object",
"severity": "error",
"given": "$.spec.messageUri",
"then": {
"function": "schema",
"functionOptions": {
"schema": {
"type": "object"
}
}
}
},
"$-spec-messageUri-messageName-type": {
"description": "The messageName field must be of type string",
"severity": "error",
"given": "$.spec.messageUri.messageName",
"then": {
"function": "schema",
"functionOptions": {
"schema": {
"type": "string"
}
}
}
},
"$-spec-messageUri-nameType-type": {
"description": "The nameType field must be of type string",
"severity": "error",
"given": "$.spec.messageUri.nameType",
"then": {
"function": "schema",
"functionOptions": {
"schema": {
"type": "string"
}
}
}
},
"$-spec-messageUri-nameType-enum": {
"description": "The nameType field must be one of: plain, variables, jsonata, distributedVariable",
"severity": "error",
"given": "$.spec.messageUri.nameType",
"then": {
"function": "schema",
"functionOptions": {
"schema": {
"enum": [
"plain",
"variables",
"jsonata",
"distributedVariable"
]
}
}
}
},
"$-spec-messageUri-path-type": {
"description": "The path field must be of type string",
"severity": "error",
"given": "$.spec.messageUri.path",
"then": {
"function": "schema",
"functionOptions": {
"schema": {
"type": "string"
}
}
}
},
"$-spec-messageUri-queryParams-type": {
"description": "The queryParams field must be of type array",
"severity": "error",
"given": "$.spec.messageUri.queryParams",
"then": {
"function": "schema",
"functionOptions": {
"schema": {
"type": "array"
}
}
}
},
"$-spec-messageUri-queryParams-items-type": {
"description": "Items in the queryParams array must be of type object",
"severity": "error",
"given": "$.spec.messageUri.queryParams[*]",
"then": {
"function": "schema",
"functionOptions": {
"schema": {
"type": "object"
}
}
}
},
"$-spec-messageUri-queryParams[*]-name-type": {
"description": "The name field must be of type string",
"severity": "error",
"given": "$.spec.messageUri.queryParams[*].name",
"then": {
"function": "schema",
"functionOptions": {
"schema": {
"type": "string"
}
}
}
},
"$-spec-messageUri-queryParams[*]-value-type": {
"description": "The value field must be of type string",
"severity": "error",
"given": "$.spec.messageUri.queryParams[*].value",
"then": {
"function": "schema",
"functionOptions": {
"schema": {
"type": "string"
}
}
}
},
"required:$.spec.messageUri.queryParams[*]:name": {
"description": "The name field is required in queryParams array items",
"severity": "error",
"given": "$.spec.messageUri.queryParams[*]",
"then": {
"field": "name",
"function": "defined"
}
},
"type:$.spec.messageUri.queryParams[*].name:string": {
"description": "The name field in queryParams array items must be of type string",
"severity": "error",
"given": "$.spec.messageUri.queryParams[*].name",
"then": {
"function": "schema",
"functionOptions": {
"schema": {
"type": "string"
}
}
}
},
"required:$.spec.messageUri.queryParams[*]:value": {
"description": "The value field is required in queryParams array items",
"severity": "error",
"given": "$.spec.messageUri.queryParams[*]",
"then": {
"field": "value",
"function": "defined"
}
},
"type:$.spec.messageUri.queryParams[*].value:string": {
"description": "The value field in queryParams array items must be of type string",
"severity": "error",
"given": "$.spec.messageUri.queryParams[*].value",
"then": {
"function": "schema",
"functionOptions": {
"schema": {
"type": "string"
}
}
}
},
"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-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-value-type": {
"description": "The value field must be of type string",
"severity": "error",
"given": "$.spec.variable.value",
"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-expire-type": {
"description": "The expire field must be of type integer",
"severity": "error",
"given": "$.spec.distributedVariable.expire",
"then": {
"function": "schema",
"functionOptions": {
"schema": {
"type": "integer"
}
}
}
},
"$-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-setExclusive-type": {
"description": "The setExclusive field must be of type boolean",
"severity": "error",
"given": "$.spec.distributedVariable.setExclusive",
"then": {
"function": "schema",
"functionOptions": {
"schema": {
"type": "boolean"
}
}
}
},
"$-spec-distributedVariable-value-type": {
"description": "The value field must be of type string",
"severity": "error",
"given": "$.spec.distributedVariable.value",
"then": {
"function": "schema",
"functionOptions": {
"schema": {
"type": "string"
}
}
}
},
"spec-telemetry-type": {
"description": "The spec.telemetry field must be of type object",
"severity": "error",
"given": "$.spec.telemetry",
"then": {
"function": "schema",
"functionOptions": {
"schema": {
"type": "object"
}
}
}
},
"spec-telemetry-no-additional-properties": {
"description": "The spec.telemetry field must be an object with no additional properties",
"severity": "error",
"given": "$.spec.telemetry",
"then": {
"function": "schema",
"functionOptions": {
"schema": {