Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Rename ssh methods #12

Open
neur0manc opened this issue Apr 22, 2021 · 2 comments
Open

Rename ssh methods #12

neur0manc opened this issue Apr 22, 2021 · 2 comments

Comments

@neur0manc
Copy link

neur0manc commented Apr 22, 2021

To make this client more in line with the official API I'd to propose a rename of the following methods:

  • get_ssh_keys
  • get_ssh_key
  • create_ssh_key
  • update_ssh_key
  • delete_ssh_key
  • get_ssh_key_events

ssh_key is canonically without the underscore in the API. The new function names would then be

  • get_sshkeys
  • get_sshkey
  • create_sshkey
  • update_sshkey
  • delete_sshkey
  • get_sshkey_events

For backwards-compat we could alias the methods to their old names.

It's a small annoyance, but I still wanted to mention it. I'm ready to work an a pull request if this change finds acceptance.

@bkircher
Copy link
Contributor

I find the upper more correct (get_ssh_keys instead of get_sshkeys) since SSH key is really two words in English language and our API is just wrong here. But wouldn't be opposed to that as long as there are aliases.

@neur0manc
Copy link
Author

neur0manc commented Apr 30, 2021 via email

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants