Skip to content

Fix Incorrect DNS Zone API Specifications #511

@rsulli55

Description

@rsulli55

The spec for the /getDnsZone and /getDnsZones API calls say that they return JSON where the value for key "domain" is a string. However, these calls return a JSON object for the key "domain".

I ran into this problem when trying to use the go client library and this inconsistency with spec and implementation means that JSON parsing the response fails.

This issue can be reproduced with the following curl commands:

/getDnsZones

curl -H "Authorization: Bearer <personal_access_token>" https://api.netlify.com/api/v1/dns_zones/

/getDnsZone

curl -H "Authorization: Bearer <personal_access_token>" https://api.netlify.com/api/v1/dns_zones/<zone_id>/

The response I receive from these two API calls has the following type of JSON object for the "domain" key:

  "domain": {
    "id": string
    "name": string
    "user_id": string
    "created_at": string
    "updated_at": string
    "expires_at": string
    "registered_at": string
    "renewal_price": number
    "auto_renew": bool
    "auth_code": ??? (I got null),
    "transferred_at": ??? (I got null)
    "auto_renew_at": string
  }

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions