| FazBrowse GitHub Viewer | Trending | | Home |
| Tools: [Download Repo ZIP] [Original HTTPS Page] |
1 parent 4d431e5 commit ae7d3b0
1 file changed
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -102,28 +102,26 @@ Examples: | |||
| 102 | 102 | for project in group.projects.list(iterator=True): | |
| 103 | 103 | print(project) | |
| 104 | 104 | ||
| 105 | - # create a new user | ||
| 106 | - user_data = {'email': 'jen@foo.com', 'username': 'jen', 'name': 'Jen'} | ||
| 107 | - user = gl.users.create(user_data) | ||
| 108 | - print(user) | ||
| 109 | - | ||
| 110 | 105 | .. warning:: | |
| 111 | 106 | Calling ``list()`` without any arguments will by default not return the complete list | |
| 112 | 107 | of items. Use either the ``all=True`` or ``iterator=True`` parameters to get all the | |
| 113 | 108 | items when using listing methods. See the :ref:`pagination` section for more | |
| 114 | 109 | information. | |
| 115 | 110 | ||
| 116 | - You can list the mandatory, optional, and mutually exclusive attributes for object | ||
| 117 | - creation and update with the manager's ``get_create_attrs()`` and ``get_update_attrs()`` | ||
| 118 | - methods. They return 3 tuples. The first tuple is the list of mandatory attributes. | ||
| 119 | - The second tuple is the list of optional attributes. The third tuple is the mutually | ||
| 120 | - exclusive attributes: | ||
| 121 | - | ||
| 122 | 111 | .. code-block:: python | |
| 123 | 112 | ||
| 124 | - # v4 only | ||
| 125 | - print(gl.projects.get_create_attrs()) | ||
| 126 | - (('name',), ('path', 'namespace_id', ...)) | ||
| 113 | + # create a new user | ||
| 114 | + user_data = {'email': 'jen@foo.com', 'username': 'jen', 'name': 'Jen'} | ||
| 115 | + user = gl.users.create(user_data) | ||
| 116 | + print(user) | ||
| 117 | + | ||
| 118 | + .. note:: | ||
| 119 | + python-gitlab attempts to sync the required, optional, and mutually exclusive attributes | ||
| 120 | + for resource creation and update with the upstream API. | ||
| 121 | + | ||
| 122 | + You are encouraged to follow upstream API documentation for each resource to find these - | ||
| 123 | + each resource documented here links to the corresponding upstream resource documentation | ||
| 124 | + at the top of the page. | ||
| 127 | 125 | ||
| 128 | 126 | The attributes of objects are defined upon object creation, and depend on the | |
| 129 | 127 | GitLab API itself. To list the available information associated with an object | |
| Back | FazBrowse Home | New Git URL |
0 commit comments