Project

General

Profile

« Previous | Next » 

Revision d97c7e11

Added by David Davis over 10 years ago

Content Views: Updating the apidoc for v2 controller

View differences:

app/controllers/katello/api/v2/content_views_controller.rb
module Katello
class Api::V2::ContentViewsController < Api::V2::ApiController
respond_to :json
before_filter :find_content_view, :except => [:index, :create]
before_filter :find_organization, :only => [:index, :create]
before_filter :find_environment, :only => [:index]
before_filter :load_search_service, :only => [:index, :available_puppet_modules]
before_filter :authorize
wrap_parameters :include => (ContentView.attribute_names + %w(repository_ids component_ids))
def_param_group :content_view do
param :description, String, :desc => "Description for the content view"
param :repository_ids, Array, :desc => "List of repository ids"
param :component_ids, Array, :desc => "List of component content view version ids for composite views"
end
def rules
index_rule = lambda { ContentView.any_readable?(@organization) }
view_rule = lambda { @view.readable? }
......
api :POST, "/content_views", "Create a content view"
param :organization_id, :identifier, :desc => "Organization identifier", :required => true
param :name, String, :desc => "Name of the content view", :required => true
param :description, String, :desc => "Description of the content view"
param :label, String, :desc => "Content view label"
param :repositoriy_ids, Array, :desc => "List of repository ids"
param :composite, :bool, :desc => "Composite content view"
param_group :content_view
def create
@view = ContentView.create!(view_params) do |view|
view.organization = @organization
......
api :PUT, "/content_views/:id", "Update a content view"
param :id, :number, :desc => "Content view identifier", :required => true
param :name, String, :desc => "New name for the content view"
param :description, String, :desc => "Updated description for the content view"
param :repository_ids, Array, :desc => "List of repository ids"
param :component_ids, Array, :desc => "List of component content view version ids"
param_group :content_view
def update
@view.update_attributes!(view_params)

Also available in: Unified diff