Section 'links' misplaced in OS-FEDERATION identity API

Bug #1336258 reported by Marek Denis
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
openstack-api-site
Fix Released
Low
Marek Denis

Bug Description

It was discovered that section 'links' is misplaced in HTTP responses in mapping's examples in OD-FEDERATION Identity API docs: https://github.com/openstack/identity-api/blob/master/v3/src/markdown/identity-api-v3-os-federation-ext.md

For instance Response to Mapping's PUT operations is depicted as:

Status: 201 Created

{
    "links": {
        "self": "http://identity:35357/v3/OS-FEDERATION/mappings/ACME"
    },
    "mapping": {
        "id": "ACME",
        "rules": [
            {
                "local": [
                    {
                        "group": {
                            "id": "0cd5e9"
                        }
                    }
                ],
                "remote": [
                    {
                        "type": "orgPersonType",
                        "not_any_of": [
                            "Contractor",
                            "Guest"
                        ]
                    }
                ]
            }
        ]
    }
}

whereas 'links' section should be inside 'mappings' section.

Changed in keystone:
assignee: nobody → Marek Denis (marek-denis)
tags: added: documentation
Changed in keystone:
importance: Undecided → Low
Revision history for this message
Dolph Mathews (dolph) wrote :
affects: keystone → openstack-api-site
Changed in openstack-api-site:
status: New → Confirmed
status: Confirmed → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to identity-api (master)

Reviewed: https://review.openstack.org/103888
Committed: https://git.openstack.org/cgit/openstack/identity-api/commit/?id=8f3fd661f5d91e37f6a6cac895d001254a6ed21d
Submitter: Jenkins
Branch: master

commit 8f3fd661f5d91e37f6a6cac895d001254a6ed21d
Author: Marek Denis <email address hidden>
Date: Tue Jul 1 15:17:51 2014 +0200

    Fix links sections in federation mapping docs

    Links sections are misplaced in some OS-FEDERATION mappings'
    API HTTP request/response examples. They need to be moved to appropriate
    objects.

    Closes-Bug: #1336258
    Change-Id: I076b3fcfa3067b37b30280e9d00481b5a4eda671

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.