OpenStack Identity (keystone)

document base model types for key elements within Keystone API

Bug #928441 reported by Joseph Heck on 2012-02-07

This bug affects 1 person

Affects		Status	Importance	Assigned to	Milestone
	OpenStack Identity (keystone)	Fix Released	High	Joseph Heck	OpenStack Identity (keystone) 2012.2 "folsom"

Bug Description

Set up an "abstract base class" for the objects that the Keystone API interacts with, including docstring documentation to outline how they're allowed to interact with the service APIs and how they're not. This is intended to help inform Backend/driver implementors what needs to be done to work with the keystone internal APIs

* User
* Tenant
* Token
* Catalog endpoint
* Roles
* Action
* Capability

Termie's suggestion - document this in keystone/common/models.py as docstrings to solve the immediate problem of knowing what to return.

See original description

Tags:

Revision history for this message

Adam Young (ayoung) wrote on 2012-02-07:

Should not be an Abstract base class, but rather a domain model class that is not tied to any of the backend implementations.

Joseph Heck (heckj) on 2012-02-07

summary:	- create abstract base classes for key elements within Keystone API + document base model types for key elements within Keystone API
description:	updated

Jesse Andrews (anotherjesse) on 2012-02-07

Changed in keystone:
importance:	Medium → High

Revision history for this message

Joseph Heck (heckj) wrote on 2012-03-08:

Adam - didn't you effectively do this with your commit that added the LDAP backend?

Joseph Heck (heckj) on 2012-03-08

tags:

added: docs

Joseph Heck (heckj) on 2012-03-30

Changed in keystone:
status:	Confirmed → Fix Committed
milestone:	none → essex-rc2

Revision history for this message

Adam Young (ayoung) wrote on 2012-03-30:

The code in identity/model.py covers User, Tenant and Role. Token, Catalog endpoint, Action and Capability are not covered. Also the SQL Identity driver does not ensure compliance with the model.

Joseph Heck (heckj) on 2012-04-03

Changed in keystone:
status:	Fix Committed → Fix Released
milestone:	essex-rc2 → folsom-1
status:	Fix Released → Confirmed

Joseph Heck (heckj) on 2012-05-08

Changed in keystone:
assignee:	nobody → Joseph Heck (heckj)

Joseph Heck (heckj) on 2012-05-15

Changed in keystone:
milestone:	folsom-1 → folsom-2

OpenStack Infra (hudson-openstack) on 2012-06-24

Changed in keystone:
status:	Confirmed → In Progress

Revision history for this message

OpenStack Infra (hudson-openstack) wrote on 2012-07-03: Fix merged to keystone (master)

Reviewed: https://review.openstack.org/8909
Committed: http://github.com/openstack/keystone/commit/0b5cf0017175680fe0b027ab759e5aae3cba5d26
Submitter: Jenkins
Branch: master

commit 0b5cf0017175680fe0b027ab759e5aae3cba5d26
Author: Joe Heck <email address hidden>
Date: Sun Jun 24 11:59:21 2012 -0700

documenting models

    fixes bug 928441, moved models into keystone.common.models and
    roughly documented required and optional fields for various
    backends. rebased off master.

Change-Id: I711fe462c09836904a0ee238444c9f04b64a8ade

Changed in keystone:
status:	In Progress → Fix Committed

Thierry Carrez (ttx) on 2012-07-04

Changed in keystone:
status:	Fix Committed → Fix Released

Thierry Carrez (ttx) on 2012-09-27

Changed in keystone:
milestone:	folsom-2 → 2012.2

Report a bug

This report contains Public information

Everyone can see this information.

You are

Subscribing...

Edit bug mail

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.