value of the field "links" in response is not correct. ( identiy-api-doc)

Bug #1153455 reported by Haneef Ali
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
OpenStack Identity (keystone)
Invalid
Undecided
Unassigned

Bug Description

In identity api, each entity has a link element which gives an url for the entity. it is based on "Atom" link. But the syntax of the link in v3 documetation is not correct.

In v3 doc, it is given as

{
    "user": {
        "default_project_id": "263fd9",
        "domain_id": "1789d1",
        "email": "<email address hidden>",
        "enabled": true,
        "id": "0ca8f6",
        "links": {
            "self": "http://identity:35357/v3/users/0ca8f6"
        },
        "name": "Joe"
    }
}

But the the correct format of link is

"links":[{
"rel": "self",
"href": "http://identity.api.openstack.org/v2.0"
}
],

Please refer v2 version response which uses the correct format.

http://docs.openstack.org/api/openstack-identity-service/2.0/content/Versions-d1e472.html

Revision history for this message
Dolph Mathews (dolph) wrote :

The v3 API specifies a different links structure than that used by v2. See the "links" section on:

  https://github.com/openstack/identity-api/blob/master/openstack-identity-api/src/markdown/identity-api-v3.md#required-attributes

Several examples in the API doc illustrate their use.

Changed in keystone:
status: New → Invalid
Revision history for this message
Haneef Ali (haneef) wrote :

I agree but they are not conistent

Check the example for GET /projects and GET endpoints. They use atom style

Status: 200 OK

{
    "description": "desc of domain",
    "enabled": true,
    "id": "--domain-id--",
    "link": {
        "href": "http://identity:35357/v3/domains/--domain-id--",
        "rel": "self"
    },
    "name": "my domain"
}

[
    {
        "domain_id": "--domain-id--",
        "enabled": true,
        "id": "--project-id--",
        "link": {
            "href": "http://identity:35357/v3/projects/--project-id--",
            "rel": "self"
        },
        "name": "a project name"
    },
    {
        "domain_id": "--domain-id--",
        "enabled": true,
        "id": "--project-id--",
        "link": {
            "href": "http://identity:35357/v3/projects/--project-id--",
            "rel": "self"
        },
        "name": "another domain"
    }
]

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.