diff options
| author | Gauvain Pocentek <gauvain@pocentek.net> | 2018-06-09 17:22:39 +0200 |
|---|---|---|
| committer | Gauvain Pocentek <gauvain@pocentek.net> | 2018-06-09 17:22:47 +0200 |
| commit | 39c8ad5a9405469370e429548e08aa475797b92b (patch) | |
| tree | 5f27f5e22bb290aba927a84df81a9453b0aa9bc5 /docs | |
| parent | 5a855fdb7f9eadc00e8b917d43a601fdc45d514a (diff) | |
| download | gitlab-39c8ad5a9405469370e429548e08aa475797b92b.tar.gz | |
Add geo nodes API support
Fixes #524
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/api-objects.rst | 1 | ||||
| -rw-r--r-- | docs/gl_objects/geo_nodes.rst | 43 |
2 files changed, 44 insertions, 0 deletions
diff --git a/docs/api-objects.rst b/docs/api-objects.rst index 127cfa2..4e7961d 100644 --- a/docs/api-objects.rst +++ b/docs/api-objects.rst @@ -19,6 +19,7 @@ API examples gl_objects/environments gl_objects/events gl_objects/features + gl_objects/geo_nodes gl_objects/groups gl_objects/issues gl_objects/boards diff --git a/docs/gl_objects/geo_nodes.rst b/docs/gl_objects/geo_nodes.rst new file mode 100644 index 0000000..44ed391 --- /dev/null +++ b/docs/gl_objects/geo_nodes.rst @@ -0,0 +1,43 @@ +######### +Geo nodes +######### + +Reference +--------- + +* v4 API: + + + :class:`gitlab.v4.objects.GeoNode` + + :class:`gitlab.v4.objects.GeoNodeManager` + + :attr:`gitlab.Gitlab.geonodes` + +* GitLab API: https://docs.gitlab.com/ee/api/geo_nodes.html + +Examples +-------- + +List the geo nodes:: + + nodes = gl.geonodes.list() + +Get the status of all the nodes:: + + status = gl.geonodes.status() + +Get a specific node and its status:: + + node = gl.geonodes.get(node_id) + node.status() + +Edit a node configuration:: + + node.url = 'https://secondary.mygitlab.domain' + node.save() + +Delete a node:: + + node.delete() + +List the sync failure on the current node:: + + failures = gl.geonodes.current_failures() |