snyk / snyk/driftctl-docs

JSON output documentation is incomplete

Open
#219 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

kind/documentation
Dominant language
MDX
Stars
7
Forks
14
PR merge metrics
No merged PRs in 30d

Description

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"
}

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Find the driftctl JSON output documentation in the docs site and compare its example with the current output shown in this issue. Add the alerts, provider_name, and provider_version keys, then verify the documented example matches the current JSON structure.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.