Project

General

Profile

Actions

Bug #14241

closed

Missing rule name in compliance API

Added by Nicolas CHARLES about 5 years ago. Updated almost 5 years ago.

Status:
Released
Priority:
N/A
Category:
API
Target version:
Severity:
Minor - inconvenience | misleading | easy workaround
UX impact:
User visibility:
Getting started - demo | first install | Technique editor and level 1 Techniques
Effort required:
Very Small
Priority:
74
Name check:
Reviewed
Fix check:
Checked
Regression:

Description

The name of Directives appears in the output of the compliance API, but not the name of the Rules. This is fairly confusing

#  curl -k -H "X-API-Token:  A3l7RSAqK6AtOtUu3jhw93MbUaQkvsg6" -X GET 'https://localhost/rudder/api/latest/compliance/rules?level=2&prettify=true'
{
  "action": "getRulesCompliance",
  "result": "success",
  "data": {
    "rules": [
      {
        "id": "32377fd7-02fd-43d0-aab7-28460a91347b",
        "compliance": 47.37,
        "mode": "full-compliance",
        "complianceDetails": {
          "successAlreadyOK": 39.47,
          "successNotApplicable": 5.26,
          "unexpectedMissingComponent": 25.0,
          "error": 2.63,
          "unexpectedUnknownComponent": 25.0,
          "successRepaired": 2.63
        },
        "directives": [
          {
            "id": "c16e3a90-b9d7-427d-83c1-d80e33124e4c",
            "name": "File content (from remote template)",
            "compliance": 50.0,
            "complianceDetails": {
              "successAlreadyOK": 41.67,
              "successNotApplicable": 8.33,
              "unexpectedMissingComponent": 25.0,
              "unexpectedUnknownComponent": 25.0
            }
          },

Actions

Also available in: Atom PDF