GCP credential file wrong documentation

Open Beginner friendly
#1,311 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
68/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Tech stack
gcp, javascript
Domain
cloud, documentation

Research direction

Compare the GCP credential-file documentation with the credential handling shown in index.js. Update the documentation so its project field matches the format accepted by the code, then verify that the example and surrounding instructions are consistent.

Written by the indexing model from the issue text.

Description

Hi all. When validating the gcp using credential file, Documentation asks to provide in following format

{
    "project": "",
    "client_email": "",
    "private_key": ""
}

But, according to index.js file, if you are passing a credential file, you are expected to provide

{
    "project_id": "",
    "client_email": "",
    "private_key": ""
}

Please fix this error

Dominant language
JavaScript
Stars
3.8k
Forks
751
Avg merge
7d 59m
Merged PRs (30d)
2

Contributor guide

Open the contributing guide

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.

More from aquasecurity/cloudsploit

All issues in aquasecurity/cloudsploit

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.