Inconsistency in documentation (API reference) for Boolean parameters
Bug #1382787 reported by
Durgadas Kamath
This bug affects 1 person
Affects | Status | Importance | Assigned to | Milestone | |
---|---|---|---|---|---|
openstack-api-site |
Fix Released
|
Low
|
Diane Fleming |
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://
One instance in the guide are as follows:
For e.g within Users section , POST v3/users
Request:
{
"user": {
"email": "...",
"enabled": "...", <==it specifies to enclose value within double quotes which is wrong , it should be "enabled" : true|false ==>
"name": "...",
"password": "--optional--"
}
}
Changed in openstack-api-site: | |
importance: | Undecided → Low |
assignee: | nobody → Diane Fleming (diane-fleming) |
milestone: | none → liberty |
To post a comment you must log in.
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/