summaryrefslogtreecommitdiff
path: root/docs/ext/object_tmpl.j2
blob: 4bb9070b5eea698f9e1eda8b10f47510d7e89153 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
{% for attr_name, cls, dummy in obj.managers %}
.. attribute:: {{ attr_name }}

   {{ cls | classref() }} - Manager for {{ cls.obj_cls | classref() }} objects.

{% endfor %}

.. method:: save(**kwargs)

   Send the modified object to the GitLab server. The following attributes are
   sent:

{% if obj.requiredUpdateAttrs or obj.optionalUpdateAttrs %}
   {% for a in obj.requiredUpdateAttrs %}
   * ``{{ a }}`` (required)
   {% endfor %}
   {% for a in obj.optionalUpdateAttrs %}
   * ``{{ a }}`` (optional)
   {% endfor %}
{% else %}
   {% for a in obj.requiredCreateAttrs %}
   * ``{{ a }}`` (required)
   {% endfor %}
   {% for a in obj.optionalCreateAttrs %}
   * ``{{ a }}`` (optional)
   {% endfor %}
{% endif %}

   Available keys for ``kwargs`` are:

   * ``sudo`` (string or int): run the request as another user (requires admin
     permissions)