{"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":"Import HP response","properties":{"import_status":{"type":"string","description":"Response status for the import custom Heuristic Package (HP) operation:\n - RESP_STATUS_SUCCESS: Successfully imported all the files into the HP.\n - RESP_STATUS_INVALID_REQUEST: Errors detected while handling initial validation of the request, such as incorrect namespace or incorrect packaging.\n - RESP_STATUS_STATIC_VALIDITY_ERROR: For these errors, Service Health aborts the entire import process.\n - RESP_STATUS_RUNTIME_VALIDITY_ERROR: The import process went beyond static validation of HP definitions. The process encountered errors while deploying the definitions into running Service instances that make use of these definitions. Not a typical case, but no files will be imported and no rollback is supported for this type of failure. You will need to follow up on each reported error and perform the necessary corrective action.","default":"RESP_STATUS_UNKNOWN","enum":["RESP_STATUS_UNKNOWN","RESP_STATUS_SUCCESS","RESP_STATUS_INVALID_REQUEST","RESP_STATUS_STATIC_VALIDITY_ERROR","RESP_STATUS_RUNTIME_VALIDITY_ERROR"],"$$ref":"#/components/schemas/ImportHpRespStatus"},"namespace":{"description":"Namespace to which ImportHP belongs.","type":"string"},"error":{"description":"Error encountered while processing the request.","type":"string"},"pkg_warnings":{"description":"The warnings enumerated for each heuristics package. String represents the name of HpElem which encountered warning\nEg: \"pkgWarnings\":{\n \"metricclass\":{\n \"files\":{\n \"ImportAPI/MetricClass/metricSystem.json\":{\n \"fileWarnings\":[\n \"MetricClass withid: metric.device.cpu.load.neg custom is already present in Import heuristic package. Ignoring the duplicate MetricClass\"\n ]\n }\n }\n }\n },","type":"object","additionalProperties":{"type":"object","description":"Import Hp Elem Warnings","properties":{"files":{"type":"object","description":"Files of ImportHpElemWarnings","additionalProperties":{"type":"object","properties":{"file_warnings":{"description":"The warning details from the file.","type":"array","items":{"type":"string","description":"Items of list of file-warnings"}}},"description":"eg: \"files\":{\n \"ImportAPI/MetricClass/metricSystem.json\":{\n \"fileWarnings\":[\n \"MetricClass withid: metric.device.cpu.load.neg custom is already present in Import heuristic package. Ignoring the duplicate MetricClass\"\n ]\n }\n }\nkey in the map files is fileName. For each fileName the value will be list of warnings","$$ref":"#/components/schemas/ImportHpElemWarningsFileWarning"}}},"$$ref":"#/components/schemas/ImportHpElemWarnings"}},"pkg_errors":{"description":"Errors enumerated for each heuristics package. String represents the name of HpElem which encountered error\nEg: \"pkgErrors\":{\n \"configprofile\":{\n \"files\":{\n \"readFromFS/ConfigProfile/configProfL2VpnGold.json\":{\n \"fileErrors\":[\n \"invalid namespace: system. Ignoring the given file. Valid Namespace is: custom\"\n ]\n }\n }\n },","type":"object","additionalProperties":{"type":"object","description":"Import Hp package error","properties":{"files":{"type":"object","description":"Files of ImportHPkgError","additionalProperties":{"type":"object","properties":{"file_errors":{"description":"Error details for the file.","type":"array","items":{"type":"string","description":"Items of file-errors"}}},"description":"Eg: \"files\":{\n \"readFromFS/ConfigProfile/configProfL2VpnGold.json\":{\n \"fileErrors\": [\n \"invalid namespace: system. Ignoring the given file. Valid Namespace is: custom\"\n ]\n }\n }\nkey in the map files is fileName. For each fileName the value will be list of errors","$$ref":"#/components/schemas/ImportHPkgErrorFileError"}}},"$$ref":"#/components/schemas/ImportHPkgError"}}},"$$ref":"#/components/schemas/ImportHpResp","title":"ImportHpResp"}}