netlify / open-api

Open API specification of Netlify's API
https://open-api.netlify.com/#/default
MIT License
262 stars 83 forks source link

Fix Incorrect DNS Zone API Specifications #511

Open rsulli55 opened 1 year ago

rsulli55 commented 1 year ago

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
  }
woshichenghaibo commented 7 months ago

yes