RFC: Conductor - Provider / Provider Account API

Petr Blaho pblaho at redhat.com
Thu Apr 12 06:48:21 UTC 2012


On Wednesday, April 11, 2012 10:14:16 AM Scott Seago wrote:
> On 04/11/2012 05:53 AM, Petr Blaho wrote:
> > Hi,
> >
> > this is just copy of https://www.aeolusproject.org/redmine/projects/aeolus/wiki/Feature_-_ProviderProvider_Account_API
> >
> > Feature - Provider/Provider Account API
> > Summary
> > This feature will provide HTTP API for manipulating Provider and Provider Account resources in Conductor.
> >
> > The standard set of actions includes CRUD - create, read, update and delete actions for Provider and Provider Account resources.
> >
> > Owner
> > Petr Blaho
> >
> > Current status
> > Currently there is an index action for both ProvidersController and ProviderAccountsController which responds to xml format.
> > This is used in Aeolus CLI tool.
> >
> > Screencast Demo
> > TBD
> >
> > Implementation tasks
> > #3080 - Umbrella task
> > #3108 - Ensure good test coverage for Providers / Provider Accounts Controller
> > #3121 - Implement basic CRUD for Provider and ProviderAccount API
> >
> > Detailed description
> > Data structures, URL structure and Resource methods are similar to ones described in Conductor Image Management API.
> >
> One thing to keep in mind if you're looking at existing Image Management 
> API as a model is that we're doing away with the split in controllers. 
> Going forward, API and UI methods should respond to the same RESTful 
> actions as the UI. Essentially the elements common to both API and UI 
> action happen in the main part of the API method and then the respond 
> block contains those parts that differ for XML/JSON return (API) and 
> HTML return (UI).

Yes, I am aware of this. Thank you.

> 
> > TBD - examples of how to use API
> >
> > High-level implementation details
> > I want to use Test Driven Development methods for this feature.
> > It will help me write all the tests needed for this feature.
> > It will help me with possible refactoring of controllers for Provider and Provider Account resources.
> >
> > Future plan
> > Provider and Provider Account manipulation using Aeolus CLI tool.
> >
> > References
> > v2 Conductor API Provider Management BDD
> > v2 Conductor API Provider Account Management BDD
> > Conductor Image Management API
> >
> 
-- 

With regards
Petr Blaho



More information about the aeolus-devel mailing list