Inconsistency in documentation (API reference) for Boolean parameters

Bug #1382787 reported by Durgadas Kamath
6
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://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--"
    }
}

Tags: identity-api
Revision history for this message
Dolph Mathews (dolph) wrote :

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/

affects: keystone → openstack-api-site
tags: added: identity-api
Changed in openstack-api-site:
status: New → Confirmed
Changed in openstack-api-site:
importance: Undecided → Low
assignee: nobody → Diane Fleming (diane-fleming)
milestone: none → liberty
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to api-site (master)

Fix proposed to branch: master
Review: https://review.openstack.org/185466

Changed in openstack-api-site:
status: Confirmed → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to api-site (master)

Reviewed: https://review.openstack.org/185466
Committed: https://git.openstack.org/cgit/openstack/api-site/commit/?id=5465b996afc6dddcc882fe5bd25892d194f644f1
Submitter: Jenkins
Branch: master

commit 5465b996afc6dddcc882fe5bd25892d194f644f1
Author: Diane Fleming <email address hidden>
Date: Mon May 25 17:48:43 2015 -0500

    Fix "enabled" flag to boolean, and fix other examples

    Change-Id: I4a57c9deca6fbf03bb927b1b421965f1270f7b9e
    Closes-Bug: #1382787

Changed in openstack-api-site:
status: In Progress → Fix Released
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.