docs/gl_objects/namespaces.rst


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
33
34
35
36
37

##########
Namespaces
##########

Reference
---------

* v4 API:

  + :class:`gitlab.v4.objects.Namespace`
  + :class:`gitlab.v4.objects.NamespaceManager`
  + :attr:`gitlab.Gitlab.namespaces`

* GitLab API: https://docs.gitlab.com/ce/api/namespaces.html

Examples
--------

List namespaces::

    namespaces = gl.namespaces.list()

Search namespaces::

    namespaces = gl.namespaces.list(search='foo')

Get a namespace by ID or path::

  namespace = gl.namespaces.get("my-namespace")

Get existence of a namespace by path::

  namespace = gl.namespaces.exists("new-namespace")

  if namespace.exists:
      # get suggestions of namespaces that don't already exist
      print(namespace.suggests)