How to name Netlify API client instances?
See original GitHub issueFollowing from our discussion with @verythorough @DavidWells @tzmanics @Benaiah @toddmorey, we were wondering about the variable name to use when describing Netlify API client instances, in our documentation and in the plugin shape. At the moment we use netlify
, api
or client
. What are your thoughts?
Issue Analytics
- State:
- Created 4 years ago
- Comments:16 (13 by maintainers)
Top Results From Across the Web
Create sites programmatically with the Netlify API
There's a few different ways to create a site on Netlify. You can do so by clicking a few buttons in the UI,...
Read more >Netlify API documentation
Deploy modern static websites with Netlify. Get CDN, Continuous deployment, 1-click HTTPS, and all the services you need. Get started for free.
Read more >Functions and Identity | Netlify Docs
Access the Identity instance and Identity user claims in the context object with serverless functions, or trigger functions from Identity events.
Read more >How to deploy a simple site using Postman and the Netlify API
Log in to your Netlify account and get a personal access token from https://app.netlify.com/user/applications . We'll only show it on the screen ...
Read more >Build configuration overview - Netlify Docs
To change the build image for a site, go to Site settings > Build & deploy > Continuous Deployment > Build image selection,...
Read more >
Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free
Top Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Let’s close this ticket regarding the naming decision as
utils.api
seems amenable to all. Opening a separate issue, will close and link.i’m ok with
api
orutils.api
ornetlifyApi
to make it more specific. i actually don’t like the idea of addingclient
anywhere in there bc i think it might muddle what it is even more. it’s the ‘API instance of the Netlify SDK’ then we add client around there somewhere, it may get a little confusing.