yahoo-eng-team team mailing list archive
-
yahoo-eng-team team
-
Mailing list archive
-
Message #23903
[Bug 1382787] Re: Inconsistency in documentation (API reference) for Boolean parameters
It's also completely misdefined as an "xsd:string" (also in /v3/users).
I'd strongly recommend referring to the source of truth for the API,
which is currently here:
https://github.com/openstack/identity-api/blob/master/v3/src/markdown
/identity-api-v3.md
Although that document will soon be moving to this repo:
https://github.com/openstack/keystone-specs/
** Project changed: keystone => openstack-api-site
** Tags added: identity-api
** Changed in: openstack-api-site
Status: New => Confirmed
--
You received this bug notification because you are a member of Yahoo!
Engineering Team, which is subscribed to Keystone.
https://bugs.launchpad.net/bugs/1382787
Title:
Inconsistency in documentation (API reference) for Boolean parameters
Status in OpenStack API documentation site:
Confirmed
Bug description:
The Boolean parameters mentioned for the request within the API
reference guide are enclosed within double quotes ( " ) which is
wrong. This needs to be corrected
http://developer.openstack.org/api-ref-identity-v3.html
One instance in the guide are as follows:
For e.g within Users section , POST v3/users
Request:
{
"user": {
"default_project_id": "...",
"description": "...",
"domain_id": "--optional--",
"email": "...",
"enabled": "...", <==it specifies to enclose value within double quotes which is wrong , it should be "enabled" : true|false ==>
"name": "...",
"password": "--optional--"
}
}
To manage notifications about this bug go to:
https://bugs.launchpad.net/openstack-api-site/+bug/1382787/+subscriptions
References