barclamp.md

Barclamp APIs

Barclamps are the core modulization for OpenCrowbar. For that reason, the API for barclamps is more limited because changes to barclamps can cause breaking changes to the framework.

Barclamp List

Input:

Verb	URL	Options	Returns	Comments
GET	/crowbar/v2/barclamps	none	All barclamps	-

Output:

Barclamp Catalog

Provides the list of supported resources for the API

Verb	URL	Options	Returns	Comments
GET	/[:barclamp]/v2/catalog	none	Actions List	-

Barclamp Template

Input:

Verb	URL	Options	Returns	Comments
GET	/[:barclamp]/v2/template	none	Redirects to Template Instance	-

This will redirect to the Instance used for the template.

Not Supported

Barclamp API does not support create, update and delete operations.

API v1 temporary dumping ground

scope 'crowbar' do version = "1.0"

get    ":controller/#{version}/help", :action => 'help', :as => :help_barclamp
get    ":controller/#{version}/proposals/nodes", :action=>'nodes', :as => :barclamp_nodes
put    ":controller/#{version}/proposals", :action => 'proposal_create', :as => :create_proposal_barclamp
get    ":controller/#{version}/proposals", :action => 'proposals', :as => :proposals_barclamp
post   ":controller/#{version}/proposals/commit/:id", :action => 'proposal_commit', :as => :commit_proposal_barclamp
delete ":controller/#{version}/proposals/dequeue/:id", :action => 'proposal_dequeue', :as => :dequeue_barclamp
delete ":controller/#{version}/proposals/:id", :action => 'proposal_delete', :as => :delete_proposal_barclamp
post   ":controller/#{version}/proposals/:id", :action => 'proposal_update', :as => :update_proposal_barclamp
get    ":controller/#{version}/proposals/:id", :action => 'proposal_show', :as => :proposal_barclamp
get    ":controller/#{version}/elements", :action => 'elements'
get    ":controller/#{version}/elements/:id", :action => 'element_info'
match  ":controller/#{version}/transition/:id", :action => 'transition', :via => [:get, :post]
get    ":controller/#{version}", :action => 'index', :as => :index_barclamp
delete ":controller/#{version}/:id", :action => 'delete', :as => :delete_barclamp
get    ":controller/#{version}/:id", :action => 'show', :as => :show_barclamp
get    ":controller", :action => 'versions', :as => :versions_barclamp
post   ":controller/#{version}/:action/:id", :as => :action_barclamp
get    '/', :controller => 'barclamp', :action => 'barclamp_index', :as => :barclamp_index_barclamp
get    "modules/#{version}", :controller => 'barclamp', :action => 'modules', :as => :barclamp_modules
        
# Generic fall through routes
get    ":barclamp/#{version}/help", :action => 'help', :controller => 'barclamp'
get    ":barclamp/#{version}/proposals/nodes", :controller => "barclamp", :action=>'nodes'
put    ":barclamp/#{version}/proposals", :action => 'proposal_create', :controller => 'barclamp'
get    ":barclamp/#{version}/proposals", :action => 'proposals', :controller => 'barclamp'
post   ":barclamp/#{version}/proposals/commit/:id", :action => 'proposal_commit', :controller => 'barclamp'
get    ":barclamp/#{version}/proposals/status(/:id)(.:format)", :controller => 'barclamp', :action => 'proposal_status', :controller => 'barclamp'
delete ":barclamp/#{version}/proposals/:id", :action => 'proposal_delete', :controller => 'barclamp'
post   ":barclamp/#{version}/proposals/:id", :action => 'proposal_update', :controller => 'barclamp'
get    ":barclamp/#{version}/proposals/:id", :action => 'proposal_show', :controller => 'barclamp'
get    ":barclamp/#{version}/elements", :action => 'elements', :controller => 'barclamp'
get    ":barclamp/#{version}/elements/:id", :action => 'element_info', :controller => 'barclamp'
match  ":barclamp/#{version}/transition/:id", :action => 'transition', :via => [:get, :post], :controller => 'barclamp'
get    ":barclamp/#{version}", :action => 'index', :controller => 'barclamp'
get    ":barclamp/#{version}/status", :action => 'status', :controller => 'barclamp'
delete ":barclamp/#{version}/:id", :action => 'delete', :controller => 'barclamp'
get    ":barclamp/#{version}/:id", :action => 'show', :controller => 'barclamp'
get    ":barclamp", :action => 'versions', :controller => 'barclamp'
post   ":barclamp/#{version}/:action/:id", :controller => 'barclamp'

match "/", :controller => 'barclamp', :action => 'barclamp_index', :via => :get, :as => :barclamp_index_barclamp

end