Keystone-doc for endpoints are wrong. Doesn't match code

Bug #1091413 reported by Haneef Ali
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
OpenStack Identity (keystone)
Fix Released
Medium
Dolph Mathews

Bug Description

Keystone doc uses "faceing" as attibute name in the document. But in the code it is called "interace". Which is correct?

// From code
 @controller.protected
    def create_endpoint(self, context, endpoint):
        ref = self._assign_unique_id(self._normalize_dict(endpoint))
        self._require_attribute(ref, 'service_id')
        self._require_attribute(ref, 'interface')
        self.catalog_api.get_service(context, ref['service_id'])

        ref = self.catalog_api.create_endpoint(context, ref['id'], ref)
        return {'endpoint': ref}

// From doc

Create endpoint: POST /endpoints

Request:

{
    "extra": "--json-blob--",
    "facing": "[admin|public|internal]",
    "name": "name",
    "url": "..."
}

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

It should be "interface"; see the "API Resources" section of the v3 doc for the current "source of truth":

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

This section has evolved a bit ahead of the verbose examples in the "Core API" section.

Changed in keystone:
importance: Undecided → Medium
status: New → Confirmed
assignee: nobody → Dolph Mathews (dolph)
Revision history for this message
Dolph Mathews (dolph) wrote :

Review is on the identity-api project: https://review.openstack.org/18262

Changed in keystone:
status: Confirmed → In Progress
Revision history for this message
Dolph Mathews (dolph) wrote :

Unassigning due to inactivity.

Changed in keystone:
assignee: Dolph Mathews (dolph) → nobody
status: In Progress → Triaged
Dolph Mathews (dolph)
Changed in keystone:
status: Triaged → Fix Released
assignee: nobody → Dolph Mathews (dolph)
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.