Re: [openstack-dev] [horizon][api][docs] Feedback requested on proposed formatting change to API docs

2017-05-19 Thread Joe Topjian
On Fri, May 19, 2017 at 8:00 AM, Sean Dague wrote: > On 05/19/2017 08:36 AM, Monty Taylor wrote: > > On 05/17/2017 10:14 AM, Joe Topjian wrote: > >> > >> > >> On Tue, May 16, 2017 at 4:13 PM, Monty Taylor >> > wrote: > >> > >>

Re: [openstack-dev] [horizon][api][docs] Feedback requested on proposed formatting change to API docs

2017-05-19 Thread Sean Dague
On 05/19/2017 08:36 AM, Monty Taylor wrote: > On 05/17/2017 10:14 AM, Joe Topjian wrote: >> >> >> On Tue, May 16, 2017 at 4:13 PM, Monty Taylor > > wrote: >> >> Hey all! >> >> I read the API docs A LOT. (thank you to all of you who have

Re: [openstack-dev] [horizon][api][docs] Feedback requested on proposed formatting change to API docs

2017-05-19 Thread Monty Taylor
On 05/17/2017 10:14 AM, Joe Topjian wrote: On Tue, May 16, 2017 at 4:13 PM, Monty Taylor > wrote: Hey all! I read the API docs A LOT. (thank you to all of you who have worked on writing them) As I do, a gotcha I hit up

Re: [openstack-dev] [horizon][api][docs] Feedback requested on proposed formatting change to API docs

2017-05-17 Thread Joe Topjian
On Tue, May 16, 2017 at 4:13 PM, Monty Taylor wrote: > Hey all! > > I read the API docs A LOT. (thank you to all of you who have worked on > writing them) > > As I do, a gotcha I hit up against a non-zero amount is mapping the > descriptions of the response parameters to

Re: [openstack-dev] [horizon][api][docs] Feedback requested on proposed formatting change to API docs

2017-05-17 Thread Sean Dague
On 05/17/2017 07:40 AM, Chris Dent wrote: > On Tue, 16 May 2017, Monty Taylor wrote: > >> The questions: >> >> - Does this help, hurt, no difference? >> - servers[].name - servers is a list, containing objects with a name >> field. Good or bad? >> - servers[].addresses.$network-name - addresses

Re: [openstack-dev] [horizon][api][docs] Feedback requested on proposed formatting change to API docs

2017-05-17 Thread Chris Dent
On Tue, 16 May 2017, Monty Taylor wrote: The questions: - Does this help, hurt, no difference? - servers[].name - servers is a list, containing objects with a name field. Good or bad? - servers[].addresses.$network-name - addresses is an object and the keys of the object are the name of the

Re: [openstack-dev] [horizon][api][docs] Feedback requested on proposed formatting change to API docs

2017-05-16 Thread Qiming Teng
On Tue, May 16, 2017 at 05:13:16PM -0500, Monty Taylor wrote: > Hey all! > > I read the API docs A LOT. (thank you to all of you who have worked > on writing them) > > As I do, a gotcha I hit up against a non-zero amount is mapping the > descriptions of the response parameters to the form of the

[openstack-dev] [horizon][api][docs] Feedback requested on proposed formatting change to API docs

2017-05-16 Thread Monty Taylor
Hey all! I read the API docs A LOT. (thank you to all of you who have worked on writing them) As I do, a gotcha I hit up against a non-zero amount is mapping the descriptions of the response parameters to the form of the response itself. Most of the time there is a top level parameter under