{"type":"model","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/f445c17e25a1120e8fbde4bd413083d0fd88b2b3/42552ab7-d679-37b0-afe0-7313ad2e8c01","info":{"title":"Service Health Heuristic Packages APIs","description":"APIs for requesting rule and metric data stored by the Crosswork Service Health application.","termsOfService":"terms-of-service","contact":{"name":"Crosswork Team, Cisco","email":"support@cisco.com"},"license":{"name":"Cisco Software License Agreement","url":"http://www.cisco.com/public/sw-license-agreement.html"},"version":"7.1.0"},"security":[{"bearerAuth":[]}],"x-parser-conf":{"overview":{"markdownPath":"reference/ServiceHealth/sh_heuristic_packages_overview.md"}},"openapi":"3.0.1","servers":[{"url":"/crosswork/aa/hpmgr"}],"securitySchemes":{"bearerAuth":{"type":"apiKey","description":"Security token for authorizing requests for these APIs.","name":"Authorization","in":"header"}}},"spec":{"type":"object","description":"Subservice Class Dependency","properties":{"type":{"type":"string","description":"Dependency Type:\n - DEP_TYPE_EXPRESSION: DEP_TYPE_SUBSERVICE = 1. Not supported for MVP-1","default":"DEP_TYPE_UNSPECIFIED","enum":["DEP_TYPE_UNSPECIFIED","DEP_TYPE_EXPRESSION","DEP_TYPE_METRIC"],"$$ref":"#/components/schemas/SubserviceClassDependencyType"},"label":{"type":"string","description":"Label used to refer to this Dependency elsewhere, within this SubserviceType definition. The label acts as the key."},"eval_expression":{"description":"The compute-expression to be evaluated by this dependency. Note that this property is currently overloaded in order to provide ClassNames for Subservice or Metric types of dependencies. It may be better to have separate fields for this purpose. ","type":"string"},"namespace":{"type":"string","description":"In case of Metric and Rule Dependency types, specify the namespace. If not specified, it defaults to the current Subservice Class namespace."},"symptom":{"type":"object","properties":{"format_string":{"type":"string","description":"Format-string"},"level":{"type":"string","description":"Symptom level","default":"BROKEN","enum":["BROKEN","DEGRADED","WARNING","CRITICAL","INFO"],"$$ref":"#/components/schemas/SymptomLevel"},"priority":{"description":"The lower the value, higher the priority. The lowest valid value is 1, so the highest priority is represented by '1'. When this value is not explicitly defined in the SubserviceClass, the value defaults to '255' in the backend. This is the behavior even in cases where the priority in the SubserviceClass is explicitly defined as '0'.","type":"integer","format":"int64"},"preempt_priority":{"type":"integer","description":"Preempt priority is used to determine whether a symptom should preempt another symptom that belongs\nto the same preemption group. Example: When Interface Operational state is down due to Admin state\nbeing down, then User would need to see only Admin down symptom and not Operational down symptom.\nTo make this happen, we group Admin down and Operational down symptoms under one preemption group --\nany arbitrary string that identifies the group nature of these 2 symptoms. Then we assign higher\npremption priority, say 1, to Admin associated symptom and lower premption priority, say 2,\nto Oper associated symptom.\nBy default, no preemption is enabled i.e., all symptoms defined within a Subservice Class will\nbelong to the same group and have same default preempt_priority value 0.","format":"int64"},"preempt_group":{"type":"string","description":"preempt_group"},"raise_when":{"type":"boolean","description":"Determines whether to raise a symptom when its associated expression evaluates to true or false.\nDefault(false), raises symptom when the respective eval_expression evaluates to false.\nIf set to true, then symptom is raised when the respective eval_expression evaluates to true."}},"description":"The symptom text and the failed subexpressions.","$$ref":"#/components/schemas/SubserviceClassSymptom"},"param_map":{"description":"Map of dependency Subservice/Metric parameters to current Subservice Class parameters","type":"object","additionalProperties":{"type":"string"}},"id":{"description":"Unique ID allocated by Service Health","type":"string"}},"$$ref":"#/components/schemas/SubserviceClassDependency","title":"SubserviceClassDependency"}}