Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

More examples? #297

Closed
mperham opened this issue Sep 7, 2022 · 3 comments
Closed

More examples? #297

mperham opened this issue Sep 7, 2022 · 3 comments

Comments

@mperham
Copy link

mperham commented Sep 7, 2022

Hi, I thought it was a little strange, in looking for documentation on this library, I couldn't find a single example of how to actually add a DNS record to a domain in DNSimple.

https://github.com/dnsimple/dnsimple-ruby#usage

How do I programmatically add an A, AAAA or CNAME to my example.com domain?

@OleMchls
Copy link
Contributor

OleMchls commented Sep 7, 2022

Hey @mperham,

Thanks for the feedback 👏 What you are looking for is creating a zone record: https://dnsimple.dev/v2/zones/records/#createZoneRecord

We've some examples here in the yard doc here: https://github.com/dnsimple/dnsimple-ruby/blob/main/lib/dnsimple/client/zones_records.rb#L76

And, did you know that we've a dedicated repo for some examples with all clients, here is the ruby/zone record one:
https://github.com/dnsimple/dnsimple-api-examples/blob/main/ruby/zone_records.rb

You can also find some code examples here on the public pages: https://dnsimple.com/api/ruby

I hope I could answer your question. If not, please always feel free to reach out to support@dnsimple.com 👍

@mperham
Copy link
Author

mperham commented Sep 7, 2022

Perhaps the README for this repository should point to those resources!

@jacegu
Copy link
Contributor

jacegu commented Sep 19, 2022

@mperham sorry about that, and thanks for bringing it up.

Some of those links were spread out through the README, but were hard to spot. We have updated the structure to make them easier to find (#301). We will also be adding explicit examples for the most relevant use cases in the near future.

@jacegu jacegu closed this as completed Sep 19, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants