response examples of lists role APIs are lacking

[Masahito Muroi]

Some listing roles APIs of responce examples are lacking.

https://github.com/openstack/keystone-specs/blob/5fb080c41937614a867c4471e9b6c8a1c2ee59f0/api/v3/identity-api-v3.rst#create-role

For example:
Lists role for a user on a domain API's example is

[
    {
        "id": "--role-id--",
        "name": "--role-name--"
    },
    {
        "id": "--role-id--",
        "name": "--role-name--"
    }
]

but the actual API's response is
{
    "links": {
        "next": null,
        "previous": null,
        "self": "http://192.168.56.10:5000/v3/domains/716d729b22d647e5a04a2405d66c5eff/users/21de7aaafeb9454ba4c5b40b19016199/roles"
    },
    "roles": [
        {
            "id": "3d4b58f4be7649a497bb18b3f2e25d76",
            "links": {
                "self": "http://192.168.56.10:5000/v3/roles/3d4b58f4be7649a497bb18b3f2e25d76"
            },
            "name": "Member"
        }
    ]
}

Same lacks exist in
- Lists roles for a user on a domain.
- Lists roles for a specified domain group.
- Lists roles for a user in a project.
- Lists roles for a project group.
- Lists roles.
- Lists policies.

These API's response examples don't have "roles", "links", "next", "previous" and "self" keys.

[Anne Gentle (annegentle)]

Where do you see these response examples? That will help us know where to fix.

[Masahito Muroi (muroi-masahito)]

I see the examples in Complete API Reference[1] .

[1] http://developer.openstack.org/api-ref-identity-v3.html

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/154781
Committed: https://git.openstack.org/cgit/openstack/api-site/commit/?id=1d8c850921b8de999c1471ed88c1e17b95cbe3eb
Submitter: Jenkins
Branch: master

commit 1d8c850921b8de999c1471ed88c1e17b95cbe3eb
Author: tuathail <email address hidden>
Date: Tue Feb 10 18:52:15 2015 +0000

    Updates samples responses to API calls

    According to bug 1370477 the sample responses provided lack the
    "roles", "links", "next", "previous" and "self" keys. They are
    added in in this commit.

    Change-Id: I62b285f748c7796944ba5307db4d0905c5fd63c0
    Closes-Bug: #1370477

[Steve Martinelli (stevemar)]

@ciaran-otuathail - is a patch being submitted to keystone-specs?

[Steve Martinelli (stevemar)]

I'm not seeing an issue on the keystone side, not sure why this was confirmed. Looks fine to me:

http://specs.openstack.org/openstack/keystone-specs/api/v3/identity-api-v3.html#list-roles
http://specs.openstack.org/openstack/keystone-specs/api/v3/identity-api-v3.html#list-user-s-roles-on-domain
http://specs.openstack.org/openstack/keystone-specs/api/v3/identity-api-v3.html#list-group-s-roles-on-domain
http://specs.openstack.org/openstack/keystone-specs/api/v3/identity-api-v3.html#list-user-s-roles-on-project
http://specs.openstack.org/openstack/keystone-specs/api/v3/identity-api-v3.html#list-group-s-roles-on-project

Closing this as invalid