Project

General

Profile

Actions

Bug #7900

closed

API documentation for compliance needs JSON prettified

Added by Jonathan CLARKE about 5 years ago. Updated about 5 years ago.

Status:
Released
Priority:
N/A
Category:
Documentation
Target version:
Severity:
User visibility:
Effort required:
Priority:

Description

The JSON examples in http://www.rudder-project.org/rudder-api-doc/#api-Nodes-acceptedNodeDetails are very hard to read for a human, and don't match the format used in the rest of the documentation. They make it pretty much impossible to figure out the data structure to expect:

Rest of documentation:

      {
        "action":"createRule",
        "id":"73fb7802-5326-483a-a6d6-c29e78449558",
        "result":"success",
        "data":{
          "rules":[{
            "id":"73fb7802-5326-483a-a6d6-c29e78449558",
            "displayName":"Cloned Rule",
            "shortDescription":"",
            "longDescription":"",
            "directives":["c4f58823-5cd6-455b-b0bc-1511c51e2533"],
            "targets":["group:1e975cb2-b929-46f5-9b1c-5e4d5d5f1027"],
            "enabled":false,
            "system":false
          }]
        }
      }

Compliance API documentation:

      {
        "data": {
          "nodes": [
            {
              "rules": [
                {
                  "directives": [
                    {
                      "components": [
                        {
                          "values": [
                            {
                              "reports": [
                                {
                                  "status": "noReport" 
                                }
                              ],
                              "value": "None" 
                            }
                          ],
                          "complianceDetails": {
                            "noReport": 100
                          },
                          "compliance": 0,
                          "name": "ZMD process" 
                        },

Actions #1

Updated by Vincent MEMBRÉ about 5 years ago

  • Target version changed from 2.11.19 to 2.11.20
Actions #2

Updated by Alexis MOUSSET about 5 years ago

  • Status changed from New to In progress
  • Assignee changed from Vincent MEMBRÉ to Alexis MOUSSET
Actions #3

Updated by Alexis MOUSSET about 5 years ago

  • Status changed from In progress to Pending technical review
  • Assignee changed from Alexis MOUSSET to François ARMAND
  • Pull Request set to https://github.com/Normation/rudder-api-doc/pull/28
Actions #4

Updated by Alexis MOUSSET about 5 years ago

  • Status changed from Pending technical review to Pending release
  • % Done changed from 0 to 100
Actions #5

Updated by Vincent MEMBRÉ about 5 years ago

  • Status changed from Pending release to Released

This bug has been fixed in Rudder 2.11.20, 3.0.15, 3.1.9 and 3.2.2 which were released today.

Actions

Also available in: Atom PDF