OS-EP-FILTER documentation is incorrect

Bug #1654613 reported by Lance Bragstad
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
OpenStack Identity (keystone)
Fix Released
Medium
Lance Bragstad

Bug Description

The examples in the OS-EP-FILTER documentation aren't exactly accurate [0]. The documentation could also benefit from some rewording and fresh examples. The following could be fixed:

 - filtering by `region` isn't allowed, we should tell people to use `region_id`
 - the example mixes terminology between service and region
 - the uuid of the `service_id` changes from 1b501 to 1b501a, they should be consistent
 - we should provide a better example between endpoint project associations and endpoint groups

[0] http://developer.openstack.org/api-ref/identity/v3-ext/index.html

Tags: api-ref
tags: added: documentation
Changed in keystone:
status: New → Confirmed
importance: Undecided → Medium
Changed in keystone:
milestone: none → ocata-3
milestone: ocata-3 → none
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to keystone (master)

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

Changed in keystone:
assignee: nobody → Lance Bragstad (lbragstad)
status: Confirmed → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote :

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

Changed in keystone:
assignee: Lance Bragstad (lbragstad) → Steve Martinelli (stevemar)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to keystone (master)

Reviewed: https://review.openstack.org/417528
Committed: https://git.openstack.org/cgit/openstack/keystone/commit/?id=6e71105ddc5ca0c7014a6bce369fa5b0d1236f54
Submitter: Jenkins
Branch: master

commit 6e71105ddc5ca0c7014a6bce369fa5b0d1236f54
Author: Lance Bragstad <email address hidden>
Date: Fri Jan 6 22:35:07 2017 +0000

    [api-ref] Clean up OS-EP-FILTER documentation

    The OS-EP-FILTER documentation needed some work. The wording around
    several of the examples didn't make a whole lot of sense. And some of
    the requests were copy/pastes from other examples.

    This change attempts to clarify the need for endpoint groups and how
    they can be useful. This patch also moves the endpoint group CRUD
    documentation to the beginning of the section, which leaves the rest
    of the section to explain how to associate projects to endpoints
    directly or use endpoint groups. Previously, the endpoint group CRUD
    was in the middle of the section and made the flow the document jump
    around a bit.

    Change-Id: I1f6cbecc5c3a4c8e86a73a3cfed4b9a09e43b31f
    Partial-Bug: 1654613

Changed in keystone:
assignee: Steve Martinelli (stevemar) → Lance Bragstad (lbragstad)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote :

Reviewed: https://review.openstack.org/417533
Committed: https://git.openstack.org/cgit/openstack/keystone/commit/?id=d4129c239c88c890f6124614bce6703949f46a0c
Submitter: Jenkins
Branch: master

commit d4129c239c88c890f6124614bce6703949f46a0c
Author: Lance Bragstad <email address hidden>
Date: Fri Jan 6 23:06:13 2017 +0000

    [api-ref] Clean up OS-EP-FILTER association docs

    This change builds on the previous one by cleaning up all the wording
    around associations and makes them consistent regardless of the
    associations being direct or via endpoint groups.

    Change-Id: I9582c5e8dbb83c37abcb432835dd7b609bd7841c
    Closes-Bug: 1654613

Changed in keystone:
status: In Progress → Fix Released
Changed in keystone:
milestone: none → ocata-3
tags: added: api-ref
removed: documentation
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix included in openstack/keystone 11.0.0.0b3

This issue was fixed in the openstack/keystone 11.0.0.0b3 development milestone.

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.