rafapaulin commented 6 months ago

Proposed Changes

Change the implementation of the GetHTTPJSONResult function so that it returns the JSON data returned from the HTTP call as a map that can be, later, typed by the function that uses the util. This way the general implementation ends up clearer and more concise.

Contribution type

[x] General refactor (changes implementation, but not behavior)
[x] Bug fix (non-breaking change which fixes an issue)
[x] New feature (non-breaking change which adds functionality)
[x] Breaking change (fix or feature that would cause existing functionality to not work as expected)
[x] Documentation update/improvement

Related Issue(s)

Closes #40

Motivation, Context and Extra Info

Currently, GetHTTPJSONResult modifies a var reference to "return" the data retrieved from the HTTP call. This behavior is not ideal, and may lead to poor maintenance/unexpected behavior in the future. Not to mention that it kills the idiomatic go concept.

Checks

General

[x] I have read the org's CONTRIBUTING file
[x] All my commit messages follow conventional-commit standards (remember: we use them to auto-generate the CHANGELOG file :sweat_smile:)
[x] I confirmed that there aren't any other open PR about the same issue

Code Standards

[x] I have performed a self-review of my own code
[x] Code Lint pass locally with my changes
[x] My code follows the style guidelines of this project
[x] I have commented my code, particularly in hard-to-understand areas

Documentation and reliability

[x] My branch is up to date with the project's base branch
[x] I have made corresponding changes to the documentation
[x] The documentation changes follow the repository's docs standards
[x] My changes generate no new warnings

Testing

[x] Existing automated tests pass locally with my changes
[x] I have added new unit/integration tests that prove my fix is effective or that my feature works

How to verify the changes

Unit tests are passing
running main.go should not return any errors, and you should be able to see all types of data implemented so far (Org, property, env and variables)