← Back to team overview

yahoo-eng-team team mailing list archive

[Bug 1336265] [NEW] Wrong HTTP examples in OS-FEDERATION Trusted Attributes API docs

 

Public bug reported:

OS-FEDERATION IDentity API's trusted attribute's HTTP requests and
responses are not correct:

For instance (https://github.com/openstack/identity-
api/blob/master/v3/src/markdown/identity-api-v3-os-federation-ext.md
#get-an-identity-providers-set-of-trusted-attributes-get-os-
federationidentity_providersidp_idtrusted_attributes)

Response to GET request

{
    "trusted_attributes": [
        {
            "type": "email",
            "values": []
        },
        {
            "type": "orgPersonType",
            "values": ["staff", "contractor", "guest"]
        },
        {
            "type": "uid",
            "values": []
        }
    ],
    "links": {
        "identity_provider": "http://identity:35357/v3/OS-FEDERATION/identity_providers/7e23a6";,
        "self": "http://identity:35357/v3/OS-FEDERATION/identity_providers/7e23a6/trusted_attributes";
    }
}


HTTP JSON response should:
-always have a 'top' level object (like identity_provider, mapping, protocol)
- include proper links section

- Complex responses should have a 'top level' object with a plural noun
(identity_providers, mappings, protocols) as a key and list as a value

- Complex responses should have proper links section

** Affects: keystone
     Importance: Undecided
         Status: New

-- 
You received this bug notification because you are a member of Yahoo!
Engineering Team, which is subscribed to Keystone.
https://bugs.launchpad.net/bugs/1336265

Title:
  Wrong HTTP examples in OS-FEDERATION Trusted Attributes API docs

Status in OpenStack Identity (Keystone):
  New

Bug description:
  OS-FEDERATION IDentity API's trusted attribute's HTTP requests and
  responses are not correct:

  For instance (https://github.com/openstack/identity-
  api/blob/master/v3/src/markdown/identity-api-v3-os-federation-ext.md
  #get-an-identity-providers-set-of-trusted-attributes-get-os-
  federationidentity_providersidp_idtrusted_attributes)

  Response to GET request

  {
      "trusted_attributes": [
          {
              "type": "email",
              "values": []
          },
          {
              "type": "orgPersonType",
              "values": ["staff", "contractor", "guest"]
          },
          {
              "type": "uid",
              "values": []
          }
      ],
      "links": {
          "identity_provider": "http://identity:35357/v3/OS-FEDERATION/identity_providers/7e23a6";,
          "self": "http://identity:35357/v3/OS-FEDERATION/identity_providers/7e23a6/trusted_attributes";
      }
  }

  
  HTTP JSON response should:
  -always have a 'top' level object (like identity_provider, mapping, protocol)
  - include proper links section

  - Complex responses should have a 'top level' object with a plural
  noun (identity_providers, mappings, protocols) as a key and list as a
  value

  - Complex responses should have proper links section

To manage notifications about this bug go to:
https://bugs.launchpad.net/keystone/+bug/1336265/+subscriptions


Follow ups

References