mirror of
https://github.com/ctripcorp/zeus.git
synced 2024-09-20 23:56:05 +08:00
update api doc
This commit is contained in:
parent
697cc5ccac
commit
a446a4e0e6
|
@ -44,7 +44,8 @@ public class CertificateResource {
|
||||||
private ResponseHandler responseHandler;
|
private ResponseHandler responseHandler;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @api {post} /api/cert/upload: Upload certificate if and only if the domain does not have any history certificates
|
* @api {post} /api/cert/upload: Upload certificate
|
||||||
|
* @apiDescription Upload certificate if and only if the domain does not have any history certificates.
|
||||||
* @apiName UploadCertificate
|
* @apiName UploadCertificate
|
||||||
* @apiGroup Certificate
|
* @apiGroup Certificate
|
||||||
* @apiParam {Long} domain domain name of the certificate. Use '|' to join multiple domain values as a whole.
|
* @apiParam {Long} domain domain name of the certificate. Use '|' to join multiple domain values as a whole.
|
||||||
|
@ -72,7 +73,8 @@ public class CertificateResource {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @api {post} /api/cert/upgrade: Upgrade certificate if history certificate exists of the domain
|
* @api {post} /api/cert/upgrade: Upgrade certificate
|
||||||
|
* @apiDescription Upgrade certificate if history certificate exists for the domain. An extra installation of virtual server is required for the new certificate to take effect.
|
||||||
* @apiName UpgradeCertificate
|
* @apiName UpgradeCertificate
|
||||||
* @apiGroup Certificate
|
* @apiGroup Certificate
|
||||||
* @apiParam {Long} domain domain name of the certificate. Use '|' to join multiple domain values as a whole.
|
* @apiParam {Long} domain domain name of the certificate. Use '|' to join multiple domain values as a whole.
|
||||||
|
@ -102,7 +104,7 @@ public class CertificateResource {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @api {post} /api/cert/activate: Activate canary certificate
|
* @api {get} /api/cert/activate: Activate canary certificate
|
||||||
* @apiName ActivateCertificate
|
* @apiName ActivateCertificate
|
||||||
* @apiGroup Certificate
|
* @apiGroup Certificate
|
||||||
* @apiParam {Long} certId id of certificate to be activated
|
* @apiParam {Long} certId id of certificate to be activated
|
||||||
|
@ -119,7 +121,7 @@ public class CertificateResource {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @api {post} /api/cert/activate: Activate canary certificate
|
* @api {get} /api/cert/remoteInstall: Install certificate for virtual server
|
||||||
* @apiName ActivateCertificate
|
* @apiName ActivateCertificate
|
||||||
* @apiGroup Certificate
|
* @apiGroup Certificate
|
||||||
* @apiParam {Long} certId id of certificate to be installed
|
* @apiParam {Long} certId id of certificate to be installed
|
||||||
|
@ -159,6 +161,15 @@ public class CertificateResource {
|
||||||
return responseHandler.handle("Certificates uploaded. Re-activate the virtual server to take effect.", hh.getMediaType());
|
return responseHandler.handle("Certificates uploaded. Re-activate the virtual server to take effect.", hh.getMediaType());
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @api {get} /api/cert/default/remoteInstall: Install default certificate for slb
|
||||||
|
* @apiName RemoteInstallDefaultCertificate
|
||||||
|
* @apiGroup Certificate
|
||||||
|
* @apiParam {Long} slbId id of slb to (re-)install default certificate
|
||||||
|
* @apiParam {String} domain domain of slb's default server
|
||||||
|
* @apiParam {Boolean} force [optional] force to overwrite the certificate file if exists
|
||||||
|
* @apiSuccess {String} message success message
|
||||||
|
*/
|
||||||
@GET
|
@GET
|
||||||
@Path("/default/remoteInstall")
|
@Path("/default/remoteInstall")
|
||||||
public Response remoteInstallDefault(@Context HttpServletRequest request,
|
public Response remoteInstallDefault(@Context HttpServletRequest request,
|
||||||
|
|
|
@ -378,7 +378,7 @@ public class GroupResource {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @api {get} /api/group/update: Update group content
|
* @api {post} /api/group/update: Update group content
|
||||||
* @apiName UpdateGroup
|
* @apiName UpdateGroup
|
||||||
* @apiGroup Group
|
* @apiGroup Group
|
||||||
* @apiSuccess {Group} group json object
|
* @apiSuccess {Group} group json object
|
||||||
|
|
|
@ -210,7 +210,7 @@ public class VirtualServerResource {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @api {get} /api/vs/update: Update vs content
|
* @api {post} /api/vs/update: Update vs content
|
||||||
* @apiName UpdateVs
|
* @apiName UpdateVs
|
||||||
* @apiGroup VirtualServer
|
* @apiGroup VirtualServer
|
||||||
* @apiSuccess {VirtualServer} vs json object
|
* @apiSuccess {VirtualServer} vs json object
|
||||||
|
|
Loading…
Reference in a new issue