horizon/openstack_dashboard/static/openstack-service-api/cinder.service.js
Ryan Peters 14eb8040da ngReorg - Move API files to openstack_dashboard
This commit moves the Angular-based API services to the
openstack_dashboard directory.

It also simplifies the naming scheme for the Angular-based
API modules.

Fixes all JSCS issues in files that were modified by this patch.

This is one step in a larger effort to restructure the Angular
source. See https://review.openstack.org/#/c/176152/ for the
full set of planned changes.

Change-Id: I4200336508761fb0155be422ebcecd4bf2907035
Closes-Bug: #1446886
2015-06-15 15:50:16 -05:00

86 lines
2.6 KiB
JavaScript

/*
Copyright 2015 IBM Corp.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
(function () {
'use strict';
angular
.module('horizon.openstack-service-api')
.service('horizon.openstack-service-api.cinder', CinderAPI);
CinderAPI.$inject = ['horizon.framework.util.http.service',
'horizon.framework.widgets.toast.service'];
/**
* @ngdoc service
* @name horizon.openstack-service-api.cinder
* @description Provides direct access to Cinder APIs.
*/
function CinderAPI(apiService, toastService) {
// Volumes
/**
* @name horizon.openstack-service-api.cinder.getVolumes
* @description
* Get a list of volumes.
*
* The listing result is an object with property "items." Each item is
* a volume.
*
* @param {Object} params
* Query parameters. Optional.
*
* @param {string} param.search_opts
* Filters to pass through the API.
* For example, "status": "available" will show all available volumes.
*/
this.getVolumes = function(params) {
var config = (params) ? {'params': params} : {};
return apiService.get('/api/cinder/volumes/', config)
.error(function () {
toastService.add('error', gettext('Unable to retrieve the volumes.'));
});
};
// Volume Snapshots
/**
* @name horizon.openstack-service-api.cinder.getVolumeSnapshots
* @description
* Get a list of volume snapshots.
*
* The listing result is an object with property "items." Each item is
* a volume snapshot.
*
* @param {Object} params
* Query parameters. Optional.
*
* @param {string} param.search_opts
* Filters to pass through the API.
* For example, "status": "available" will show all available volume
* snapshots.
*/
this.getVolumeSnapshots = function(params) {
var config = (params) ? {'params': params} : {};
return apiService.get('/api/cinder/volumesnapshots/', config)
.error(function () {
toastService.add('error',
gettext('Unable to retrieve the volume snapshots.'));
});
};
}
}());