Consistent casing in DNS related operations (Dns vs DNS)
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 323
- Forks
- 133
- Avg merge
- 2d 8h
- Merged PRs (30d)
- 2
Description
Most DNS related operations spell "DNS" as Dns, for example:
https://github.com/netlify/open-api/blob/d582bdbbc73abbe8bdaf5411a35f9b11282009fa/swagger.yml#L2753
https://github.com/netlify/open-api/blob/d582bdbbc73abbe8bdaf5411a35f9b11282009fa/swagger.yml#L2771
https://github.com/netlify/open-api/blob/d582bdbbc73abbe8bdaf5411a35f9b11282009fa/swagger.yml#L2794
https://github.com/netlify/open-api/blob/d582bdbbc73abbe8bdaf5411a35f9b11282009fa/swagger.yml#L2804
https://github.com/netlify/open-api/blob/d582bdbbc73abbe8bdaf5411a35f9b11282009fa/swagger.yml#L2835
However, there are two operations where it’s spelled DNS:
https://github.com/netlify/open-api/blob/d582bdbbc73abbe8bdaf5411a35f9b11282009fa/swagger.yml#L1348
https://github.com/netlify/open-api/blob/d582bdbbc73abbe8bdaf5411a35f9b11282009fa/swagger.yml#L1360
This is obviously not a major issue, but I ran into a “not a valid API method” error when switching between getDNSForSite and getDnsZones, since I didn’t notice the case difference. Consistent casing would help avoid small mistakes like this.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start in swagger.yml at the operations around lines 1348, 1360, 2753, 2771, 2794, 2804, and 2835. Compare the operation names and standardize the DNS/Dns casing so callers do not encounter inconsistent method names. Done means the affected operations use one consistent casing throughout the API specification.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi
- Domain
- api
- Issue type
- Refactor
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100