@apistudio/apim-cli
Version:
CLI for API Management Products
713 lines • 20.3 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 'GlobalPolicy'",
"severity": "error",
"given": "$",
"then": {
"field": "kind",
"function": "schema",
"functionOptions": {
"schema": {
"type": "string",
"enum": [
"GlobalPolicy"
]
}
}
}
},
"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-filter-api-type-type": {
"description": "The filter-api-type field must be of type array",
"severity": "error",
"given": "$.spec.filter-api-type",
"then": {
"function": "schema",
"functionOptions": {
"schema": {
"type": "array"
}
}
}
},
"$-spec-filter-api-type-minItems": {
"description": "The filter-api-type array must have at least 1 items",
"severity": "error",
"given": "$.spec.filter-api-type",
"then": {
"function": "schema",
"functionOptions": {
"schema": {
"type": "array",
"minItems": 1
}
}
}
},
"$-spec-filter-api-type-items-type": {
"description": "Items in the filter-api-type array must be of type string",
"severity": "error",
"given": "$.spec.filter-api-type[*]",
"then": {
"function": "schema",
"functionOptions": {
"schema": {
"type": "string"
}
}
}
},
"$-spec-filter-http-methods-type": {
"description": "The filter-http-methods field must be of type array",
"severity": "error",
"given": "$.spec.filter-http-methods",
"then": {
"function": "schema",
"functionOptions": {
"schema": {
"type": "array"
}
}
}
},
"$-spec-filter-http-methods-minItems": {
"description": "The filter-http-methods array must have at least 1 items",
"severity": "error",
"given": "$.spec.filter-http-methods",
"then": {
"function": "schema",
"functionOptions": {
"schema": {
"type": "array",
"minItems": 1
}
}
}
},
"$-spec-filter-http-methods-items-type": {
"description": "Items in the filter-http-methods array must be of type string",
"severity": "error",
"given": "$.spec.filter-http-methods[*]",
"then": {
"function": "schema",
"functionOptions": {
"schema": {
"type": "string"
}
}
}
},
"$-spec-filter-http-methods-items-enum": {
"description": "Items in the filter-http-methods array must be one of: GET, POST, PUT, DELETE, PATCH, HEAD",
"severity": "error",
"given": "$.spec.filter-http-methods[*]",
"then": {
"function": "schema",
"functionOptions": {
"schema": {
"enum": [
"GET",
"POST",
"PUT",
"DELETE",
"PATCH",
"HEAD"
]
}
}
}
},
"$-spec-filter-attributes-type": {
"description": "The filter-attributes field must be of type string",
"severity": "error",
"given": "$.spec.filter-attributes",
"then": {
"function": "schema",
"functionOptions": {
"schema": {
"type": "string"
}
}
}
},
"$-spec-policy-sequence-required": {
"description": "The policy-sequence field is required in the $.spec",
"severity": "error",
"given": "$.spec",
"then": {
"field": "policy-sequence",
"function": "defined"
}
},
"$-spec-policy-sequence-type": {
"description": "The policy-sequence field must be of type array",
"severity": "error",
"given": "$.spec.policy-sequence",
"then": {
"function": "schema",
"functionOptions": {
"schema": {
"type": "array"
}
}
}
},
"$-spec-policy-sequence-items-type": {
"description": "Items in the policy-sequence array must be of type object",
"severity": "error",
"given": "$.spec.policy-sequence[*]",
"then": {
"function": "schema",
"functionOptions": {
"schema": {
"type": "object"
}
}
}
},
"$-spec-policy-sequence[*]-$ref-type": {
"description": "The $ref field must be of type string",
"severity": "error",
"given": "$.spec.policy-sequence[*].$ref",
"then": {
"function": "schema",
"functionOptions": {
"schema": {
"type": "string"
}
}
}
},
"$-spec-policy-sequence-no-additional-properties": {
"description": "The policy-sequence object should only contain the defined properties: $ref",
"severity": "error",
"given": "$.spec.policy-sequence[*]",
"then": {
"function": "schema",
"functionOptions": {
"schema": {
"additionalProperties": false,
"properties": {
"$ref": {}
}
}
}
}
},
"type:$.spec.policy-sequence[*].$ref:string": {
"description": "The $ref field in policy-sequence array items must be of type string",
"severity": "error",
"given": "$.spec.policy-sequence[*].$ref",
"then": {
"function": "schema",
"functionOptions": {
"schema": {
"type": "string"
}
}
}
},
"no-additional-properties:$.spec.policy-sequence[*]": {
"description": "Items in the policy-sequence array should only contain the defined properties: $ref",
"severity": "error",
"given": "$.spec.policy-sequence[*]",
"then": {
"function": "schema",
"functionOptions": {
"schema": {
"additionalProperties": false,
"properties": {
"$ref": {}
}
}
}
}
},
"spec-required-properties": {
"description": "The spec object must contain the required properties: policy-sequence",
"severity": "error",
"given": "$.spec",
"then": {
"function": "schema",
"functionOptions": {
"schema": {
"required": [
"policy-sequence"
]
}
}
}
},
"spec-no-additional-properties": {
"description": "The spec object should only contain the defined properties: filter-api-type, filter-http-methods, filter-attributes, policy-sequence",
"severity": "error",
"given": "$.spec",
"then": {
"function": "schema",
"functionOptions": {
"schema": {
"additionalProperties": false,
"properties": {
"filter-api-type": {},
"filter-http-methods": {},
"filter-attributes": {},
"policy-sequence": {}
}
}
}
}
}
}
};