def get(self):
"""
@api {get} /config/site Get the list of the sites.
@apiName GetListSites
@apiDescription Get the list of the sites on the Agent, either activated (= in 'enabled' directory) or not (= in 'available' directory).
@apiGroup Sites
@apiParam {Boolean} [allAvailable=False] Should list all the available (not necessarily enabled) sites.
@apiSuccess (200) {List} sites List of the available or enabled sites.
@apiSuccess (200) {Boolean} allAvailable Copy of the paramater 'allAvailable' received in the query.
@apiExample Example:
GET /config/site?allAvailable=True
@apiSuccessExample Success response, retrieving all the sites
HTTP/1.1 200 OK
{
'sites': ['default', 'site1', 'site2'],
'allAvailable': true
}
@apiSuccessExample Success response, retrieving only the enabled sites
HTTP/1.1 200 OK
{
'sites': ['default'],
'allAvailable': false
}
"""
args = self.reqparse.parse_args()
list_all_sites_available = args['allAvailable']
if list_all_sites_available is not None:
list_all_sites_available = list_all_sites_available.lower(
) == 'true'
else:
list_all_sites_available = False
status, sites = IO.list_available_sites(
) if list_all_sites_available else IO.list_enabled_sites()
if status is False:
raise SiteListNotAvailable()
return {'sites': sites, 'allAvailable': list_all_sites_available}
def get(self):
"""
@api {get} /config/site Get the list of the sites.
@apiName GetListSites
@apiDescription Get the list of the sites on the Agent, either activated (= in 'enabled' directory) or not (= in 'available' directory).
@apiGroup Sites
@apiParam {Boolean} [allAvailable=False] Should list all the available (not necessarily enabled) sites.
@apiSuccess (200) {List} sites List of the available or enabled sites.
@apiSuccess (200) {Boolean} allAvailable Copy of the paramater 'allAvailable' received in the query.
@apiExample Example:
GET /config/site?allAvailable=True
@apiSuccessExample Success response, retrieving all the sites
HTTP/1.1 200 OK
{
'sites': ['default', 'site1', 'site2'],
'allAvailable': true
}
@apiSuccessExample Success response, retrieving only the enabled sites
HTTP/1.1 200 OK
{
'sites': ['default'],
'allAvailable': false
}
"""
args = self.reqparse.parse_args()
list_all_sites_available = args['allAvailable']
if list_all_sites_available is not None:
list_all_sites_available = list_all_sites_available.lower() == 'true'
else:
list_all_sites_available = False
status, sites = IO.list_available_sites() if list_all_sites_available else IO.list_enabled_sites()
if status is False:
raise SiteListNotAvailable()
return {'sites': sites,
'allAvailable': list_all_sites_available}
