netlify / netlify/open-api

Add simple example of authentication and performing simple operation with go client

Open
#167 2 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement go
Dominant language
Go
Stars
323
Forks
133
Avg merge
2d 8h
Merged PRs (30d)
2

Description

As you can tell from the subject line, this isn't a bug, it's more of a request for a simple example of authentication via Go.

I have found that as a somewhat less experienced developer, I have no idea where to start using the go client.

I am using porcelain. I created an API access token for my Netlify account, but now I am stuck. After two days of experimenting, I have still not found a way to do something as simple as list the sites in my account.

It would be great if the readme.md could include a simple auth example and one call to listsites or something similar.

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.

Research direction

Start with README.md and the Go client usage described in the issue, then identify the authentication setup for a Netlify API access token and the call that lists sites. The documentation is done when a newcomer can follow the example to authenticate and list the sites in their account.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.