Public bug reported: This came about from a discussion in IRC:
http://eavesdrop.openstack.org/irclogs/%23openstack-dev/%23openstack- dev.2018-05-30.log.html#t2018-05-30T16:13:41 The API reference here doesn't mention that for a system-scoped token, the response body can have a 'system' attribute in the 'token' object in the response body: https://developer.openstack.org/api-ref/identity/v3/index.html#validate- and-show-information-for-token The example in the API reference is for an unscoped token, but for SDK writers the API reference should have a description of all the possible response parameters and indicate if they are optional, and the description can explain in what cases they would be present in the response. For example, GET /servers/{id} can have a "fault" parameter in the response but only under certain scenarios based on the server status: https://developer.openstack.org/api-ref/compute/#show-server-details But we still document the optional parameter. ** Affects: keystone Importance: Medium Status: Confirmed ** Tags: api-ref documentation -- You received this bug notification because you are a member of Yahoo! Engineering Team, which is subscribed to OpenStack Identity (keystone). https://bugs.launchpad.net/bugs/1774229 Title: api-ref: GET /v3/auth/tokens doesn't mention the optional "system" parameter for a scoped token Status in OpenStack Identity (keystone): Confirmed Bug description: This came about from a discussion in IRC: http://eavesdrop.openstack.org/irclogs/%23openstack-dev/%23openstack- dev.2018-05-30.log.html#t2018-05-30T16:13:41 The API reference here doesn't mention that for a system-scoped token, the response body can have a 'system' attribute in the 'token' object in the response body: https://developer.openstack.org/api-ref/identity/v3/index.html #validate-and-show-information-for-token The example in the API reference is for an unscoped token, but for SDK writers the API reference should have a description of all the possible response parameters and indicate if they are optional, and the description can explain in what cases they would be present in the response. For example, GET /servers/{id} can have a "fault" parameter in the response but only under certain scenarios based on the server status: https://developer.openstack.org/api-ref/compute/#show-server-details But we still document the optional parameter. To manage notifications about this bug go to: https://bugs.launchpad.net/keystone/+bug/1774229/+subscriptions -- Mailing list: https://launchpad.net/~yahoo-eng-team Post to : yahoo-eng-team@lists.launchpad.net Unsubscribe : https://launchpad.net/~yahoo-eng-team More help : https://help.launchpad.net/ListHelp