diff options
| author | Christophe Fergeau <cfergeau@redhat.com> | 2016-01-15 15:54:24 +0100 |
|---|---|---|
| committer | Christophe Fergeau <cfergeau@redhat.com> | 2016-04-08 17:04:24 +0200 |
| commit | 070bbd9894a9436090173d006d600246be011b34 (patch) | |
| tree | d4455daf9c13dbe409654167112114db57990a78 | |
| parent | 6e359ab114fe4bfdaff0c16af9d0c2946fddb696 (diff) | |
proxy: Document OvirtProxy properties
| -rw-r--r-- | govirt/ovirt-proxy.c | 28 |
1 files changed, 27 insertions, 1 deletions
diff --git a/govirt/ovirt-proxy.c b/govirt/ovirt-proxy.c index 3c7f9ce..19bd94b 100644 --- a/govirt/ovirt-proxy.c +++ b/govirt/ovirt-proxy.c @@ -881,14 +881,31 @@ ovirt_proxy_class_init(OvirtProxyClass *klass) oclass->get_property = ovirt_proxy_get_property; oclass->set_property = ovirt_proxy_set_property; + /** + * OvirtProxy:ca-cert; + * + * Path to a file containing the CA certificates to use for the HTTPS + * REST API communication with the oVirt instance + */ g_object_class_install_property(oclass, PROP_CA_CERT, g_param_spec_boxed("ca-cert", "ca-cert", - "Virt CA certificate to use when connecting to remote VM", + "Virt CA certificate to use for HTTPS REST communication", G_TYPE_BYTE_ARRAY, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS)); + + /** + * OvirtProxy:admin: + * + * Indicates whether to connect to the REST API as an admin, or as a regular user. + * Different content will be shown for the same user depending on if they connect as + * an admin or not. Connecting as an admin requires to have admin priviledges on the + * oVirt instance. + * + * Since: 0.0.2 + */ g_object_class_install_property(oclass, PROP_ADMIN, g_param_spec_boolean("admin", @@ -897,6 +914,15 @@ ovirt_proxy_class_init(OvirtProxyClass *klass) FALSE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS)); + /** + * OvirtProxy:session-id: + * + * jsessionid cookie value. This allows to use the REST API without + * authenticating first. This was used by oVirt 3.6 and is now replaced + * by OvirtProxy:sso-token. + * + * Since: 0.3.1 + */ g_object_class_install_property(oclass, PROP_SESSION_ID, g_param_spec_string("session-id", |