Skip to content

JSON output documentation is incomplete #219

@eliecharra

Description

@eliecharra

The actual documentation of driftctl about the JSON output is not complete.

3 keys are missing from the documentation:

        "alerts": null,
        "provider_name": "aws",
        "provider_version": "3.47.0"

Documented output:

{
  "summary": {
    "total_resources": 3,
    "total_changed": 1,
    "total_unmanaged": 1,
    "total_missing": 1,
    "total_managed": 1
  },
  "managed": [
    // list of resources found in IaC and in sync with remote
  ],
  "unmanaged": [
    // list of resources found in remote but not in IaC
  ],
  "missing": [
    // list of resources found in IaC but not on remote
  ],
  "differences": [
    // A list of changes on managed resources
  ],
  "coverage": 33
}

Current output:

{
        "summary": {
                "total_resources": 0,
                "total_changed": 0,
                "total_unmanaged": 0,
                "total_missing": 0,
                "total_managed": 0
        },
        "managed": null,
        "unmanaged": null,
        "missing": null,
        "differences": null,
        "coverage": 0,
        "alerts": null,
        "provider_name": "aws",
        "provider_version": "3.47.0"
}

Metadata

Metadata

Assignees

No one assigned

    Labels

    kind/documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions