Comments (1)
Hey @kamarcum thanks for all that you're doing to call out the need for consistency and patterns.
TL;DR - client.create_or_update_actions_secret(repo, name, options)
| Much like what we did here - reactions are the quintessential example for name collision
Even though it makes a bit more code / work I personally favor esoteric method names over parameter overloading. i.e. Clarity over obscurity.
My reasoning is that I believe that discoverability with APIs and SDK should be paramount (acknowledging that SDKs should also not 1:1 maps for APIs - there's a balance)
SDKs are meant to make consumption of various resources more approachable and also to abstract mundane and the known (like authentication and paging) away so that users don't have to repeat themselves.
All this to say, I feel that we should favor concrete over clever whenever we can - to best serve our new and existing consumers.
Thanks again for this! It's such a good call out! ❤️
from octokit.rb.
Related Issues (20)
- [FEAT]: Support for Environment based Repository Secrets HOT 1
- [FEAT]: Add methods for app webhooks HOT 1
- [BUG]: Fetch a given reference uses the wrong API HOT 5
- [FEAT]: add missing endpoints HOT 2
- [BUG]: OAuth token auth applies a different Authorization header than using curl or postman HOT 6
- [DOCS]: README and yardocs refer to deleted method `#create_authorization` HOT 1
- [FEAT]: Refresh a user's access token with refresh token HOT 1
- Test issue HOT 1
- [FEAT]: Support Org Secrets HOT 1
- Get Projects by personal access token-Must have admin rights to Repository HOT 3
- [FEAT]: Provide response types with Sorbet HOT 1
- [BUG]: HTTP caching middleware returns cached responses to wrong users HOT 4
- [BUG]: `list_app_installation_repositories` does not return `rels` HOT 1
- [BUG]: Net::OpenTimeout (Faraday::ConnectionFailed) for request in threads HOT 1
- [FEAT]: timeline events are not supported? HOT 2
- How to get repository by its ID? HOT 2
- [FEAT]: Add Full Code Scanning Support HOT 1
- [DOCS]: How can I use octokit to manager new project HOT 1
- [DOCS]: Fix / update generation for the docs for Octokit.rb HOT 1
- [BUG]: `faraday-multipart` warning always printed HOT 2
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from octokit.rb.