doc: sample schema code in API change tutorial code is incorrect

Bug #1597196 reported by guoshan
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
OpenStack Identity (keystone)
Fix Released
Wishlist
guoshan

Bug Description

The refactor of code cause the inappropriate guide.
Code in tutorial is out of date.

For example:
role_create = {
    'properties': {
        'name': parameter_types.name,
        'description': parameter_types.description
    }
    ...
}

role_update = {
    'properties': {
        'name': parameter_types.name,
        'description': parameter_types.description
    }
    ...
}

For better tutorial, it would be better modified.

guoshan (guoshan)
tags: added: documentation
tags: added: low-hanging-fruit
Changed in keystone:
assignee: nobody → guoshan (guoshan)
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/335341

Revision history for this message
Dave Chen (wei-d-chen) wrote : Re: API Change Tutorial doc code modify

Code is updated frequently, but these tutorial is not.

Changed in keystone:
importance: Undecided → Wishlist
Changed in keystone:
assignee: guoshan (guoshan) → Dave Chen (wei-d-chen)
status: New → In Progress
Dave Chen (wei-d-chen)
Changed in keystone:
assignee: Dave Chen (wei-d-chen) → guoshan (guoshan)
Changed in keystone:
milestone: none → newton-2
summary: - API Change Tutorial doc code modify
+ API Change Tutorial doc code for schema is incorrect
summary: - API Change Tutorial doc code for schema is incorrect
+ doc: sample schema code in API change tutorial code is incorrect
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to keystone (master)

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

commit 4db765198dcad94d480e1a8bb0314dd125f3a5de
Author: guoshan <email address hidden>
Date: Wed Jun 29 15:12:14 2016 +0800

    API Change Tutorial doc code modify

    The refactor of code cause the inappropriate guide.
    Code in tutorial is out of date.

    Change-Id: Ic986af1072f158f0f0f5608a9754db9d3e507409
    Closes-Bug: #1597196

Changed in keystone:
status: In Progress → Fix Released
Revision history for this message
Davanum Srinivas (DIMS) (dims-v) wrote : Fix included in openstack/keystone 10.0.0.0b2

This issue was fixed in the openstack/keystone 10.0.0.0b2 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.