Project

General

Profile

« Previous | Next » 

Revision 2be84f3d

Added by Joseph Magen over 10 years ago

fixes #3925 - create apipie param_groups for API v2 to DRY documentation

View differences:

app/controllers/api/v2/compute_resources_controller.rb
def show
end
def_param_group :compute_resource do
param :compute_resource, Hash, :action_aware => true do
param :name, String
param :provider, String, :desc => "Providers include #{ComputeResource::PROVIDERS.join(', ')}"
param :url, String, :required => true, :desc => "URL for Libvirt, Ovirt, and Openstack"
param :description, String
param :user, String, :desc => "Username for Ovirt, EC2, Vmware, Openstack. Access Key for EC2."
param :password, String, :desc => "Password for Ovirt, EC2, Vmware, Openstack. Secret key for EC2"
param :uuid, String, :desc => "for Ovirt, Vmware Datacenter"
param :region, String, :desc => "for EC2 only"
param :tenant, String, :desc => "for Openstack only"
param :server, String, :desc => "for Vmware"
end
end
api :POST, "/compute_resources/", "Create a compute resource."
param :compute_resource, Hash, :required => true do
param :name, String
param :provider, String, :desc => "Providers include #{ComputeResource::PROVIDERS.join(', ')}"
param :url, String, :required => true, :desc => "URL for Libvirt, Ovirt, and Openstack"
param :description, String
param :user, String, :desc => "Username for Ovirt, EC2, Vmware, Openstack. Access Key for EC2."
param :password, String, :desc => "Password for Ovirt, EC2, Vmware, Openstack. Secret key for EC2"
param :uuid, String, :desc => "for Ovirt, Vmware Datacenter"
param :region, String, :desc => "for EC2 only"
param :tenant, String, :desc => "for Openstack only"
param :server, String, :desc => "for Vmware"
end
param_group :compute_resource, :as => :create
def create
@compute_resource = ComputeResource.new_provider(params[:compute_resource])
......
api :PUT, "/compute_resources/:id/", "Update a compute resource."
param :id, String, :required => true
param :compute_resource, Hash, :required => true do
param :name, String
param :provider, String, :desc => "Providers include #{ComputeResource::PROVIDERS.join(', ')}"
param :url, String, :desc => "URL for Libvirt, Ovirt, and Openstack"
param :description, String
param :user, String, :desc => "Username for Ovirt, EC2, Vmware, Openstack. Access Key for EC2."
param :password, String, :desc => "Password for Ovirt, EC2, Vmware, Openstack. Secret key for EC2"
param :uuid, String, :desc => "for Ovirt, Vmware Datacenter"
param :region, String, :desc => "for EC2 only"
param :tenant, String, :desc => "for Openstack only"
param :server, String, :desc => "for Vmware"
end
param_group :compute_resource
def update
process_response @compute_resource.update_attributes(params[:compute_resource])

Also available in: Unified diff