set meaning descriptions in swagger.json

netbox-community / go-netbox

The official Go API client for Netbox IPAM and DCIM service.

Other

195 stars 146 forks source link

set meaning descriptions in swagger.json #50

Closed kobayashi closed 4 years ago

kobayashi commented 4 years ago

godoc shows meaningless descriptions for some client’s methods For example, ExtrasConfigContextsList is described as Call to super to allow for caching https://godoc.org/github.com/netbox-community/go-netbox/netbox/client/extras

swagger.json is generated automatically from netbox itself though, for the current version netbox v2.6 at least, it does not provide meaning descriptions.

awlx commented 4 years ago

Is it worth the effort? Or should it be fixed in the generated swagger.json?

kobayashi commented 4 years ago

Ah yeah, swagger.json shows me over 100 lines. Is it better to delete the comment or leave as it is?

$ grep "Call to super to allow for caching" swager.json |wc -l
116

kobayashi commented 4 years ago

Close this issue because this may not worth.