Add support for network-configurations endpoints

[stevehipwell]

The REST endpoints for network configurations have been announced as GA.

• Enterprise
  • Docs - see below: Add support for network-configurations endpoints #3462 (comment)
• Organization
  • OSS Docs - see below: Add support for network-configurations endpoints #3462 (comment)
  • Enterprise docs - see below: Add support for network-configurations endpoints #3462 (comment)

[gmlewis]

This would be a great PR for any new contributor to this repo or a new Go developer.
All contributions are greatly appreciated!

Feel free to volunteer for any issue and the issue can be assigned to you so that others don't attempt to duplicate the work.
Also feel free to perform a code review on any PR that has the label "NeedsReview" - we appreciate those contributions too!
We have a REVIEWERS file that you could add your username to if you are willing to be contacted when reviews are needed.

Please check out our CONTRIBUTING.md guide to get started. (In particular, please remember to go generate ./... and don't use force-push to your PRs.)

Thank you!

[rabelmervin]

Hi 👋 @stevehipwell @gmlewis Can i contribute to this issue ? I'm as an go learner. This will be a good learning opportunity for me. Any guidance would be appreciated : )

[gmlewis]

Hi 👋 @stevehipwell @gmlewis Can i contribute to this issue ? I'm as an go learner. This will be a good learning opportunity for me. Any guidance would be appreciated : )

Definitely! We welcome new Go developers to contribute, and since we do this a lot, we have attempted to concentrate our guidance into CONTRIBUTING.md so that we don't have to write up new guidance for each individual contributor.
So please read through that, and if you still have questions, feel free to ask.

[rabelmervin]

Hi @gmlewis can you tell me location where the changes need ?

[gmlewis]

@rabelmervin - here's my thinking: Maybe one of our more experienced contributors can tackle one of the major bullet points, say for example, the last one: "REST API endpoints for workflows". Most likely, a new file will need to be created (with file naming conventions covered in CONTRIBUTING.md), and the more experienced contributor will write 6 new endpoints that cover the minor bullet points under that major bullet point.

Then, when that PR is finished, you can take a look to see how they did it and you yourself could take on one of the smaller bullet points, say for example "REST API endpoints for workflow jobs" with 4 endpoints.

Otherwise, I simply don't have the time to walk you through what needs to be done.

Does that make sense?

Having said all that, I'm going to remove your name from this issue since it is an enormous task.. and since I took the time to create this bullet point list, I'll instead add individual contributor's usernames to each bullet point(s) that they wish to sign up for. Please let me know if you want your username on one of these.

[stevehipwell]

@gmlewis am I missing something here as the two APIs in the issue description (/enterprises/{enterprise}/network-configurations & /orgs/{org}/settings/network-configurations) aren't in the list you posted above?

[gmlewis]

@gmlewis am I missing something here as the two APIs in the issue description (/enterprises/{enterprise}/network-configurations & /orgs/{org}/settings/network-configurations) aren't in the list you posted above?

Thank you, @stevehipwell ! Whups! Let's try this again...

[gmlewis]

First set (one PR):

• REST API endpoints for enterprise network configurations
  • Create a hosted compute network configuration for an enterprise
  • Get a hosted compute network configuration for an enterprise
  • Update a hosted compute network configuration for an enterprise
  • Delete a hosted compute network configuration from an enterprise
  • Get a hosted compute network settings resource for an enterprise

[gmlewis]

Second set (another PR):

• REST API endpoints for network configurations (for organizations)
  • List hosted compute network configurations for an organization
  • Create a hosted compute network configuration for an organization
  • Get a hosted compute network configuration for an organization
  • Update a hosted compute network configuration for an organization
  • Delete a hosted compute network configuration from an organization
  • Get a hosted compute network settings resource for an organization

[gmlewis]

Third set (another PR):
NOTE that there may be no need for this PR if the endpoints for enterprise organizations are identical to those for non-enterprise organizations.

• REST API endpoints for network configurations (for enterprise organizations)
  • List hosted compute network configurations for an organization
  • Create a hosted compute network configuration for an organization
  • Get a hosted compute network configuration for an organization
  • Update a hosted compute network configuration for an organization
  • Delete a hosted compute network configuration from an organization
  • Get a hosted compute network settings resource for an organization

[gmlewis]

@stevehipwell - does this look accurate to you?

[stevehipwell]

I think the second and third are the same, I added links to both docs in case there were minor differences.

[rabelmervin]

@gmlewis I understand that this is a big task, Since I don’t have a clear idea on how to contribute effectively at this stage, I’ll step back for now. But I’d love to revisit and contribute go-git once I gain more familiarity.