diff options
author | Gauvain Pocentek <gauvain@pocentek.net> | 2016-08-13 20:06:14 +0200 |
---|---|---|
committer | Gauvain Pocentek <gauvain@pocentek.net> | 2016-08-13 20:06:14 +0200 |
commit | ef2dbf7034aee21ecf225be5cfefee8ab4379bbe (patch) | |
tree | 1bb59540027bd1b10e1f7bef8ece602575430eae /docs/gl_objects | |
parent | ded52580346a59e788d7c53e09d9df8ae549f60c (diff) | |
download | gitlab-ef2dbf7034aee21ecf225be5cfefee8ab4379bbe.tar.gz |
Add support for project services API
Diffstat (limited to 'docs/gl_objects')
-rw-r--r-- | docs/gl_objects/projects.py | 21 | ||||
-rw-r--r-- | docs/gl_objects/projects.rst | 34 |
2 files changed, 54 insertions, 1 deletions
diff --git a/docs/gl_objects/projects.py b/docs/gl_objects/projects.py index bcce530..0143e31 100644 --- a/docs/gl_objects/projects.py +++ b/docs/gl_objects/projects.py @@ -361,3 +361,24 @@ note.save() # notes delete note.delete() # end notes delete + +# service get +service = gl.project_services.get(service_name='asana', project_id=1) +# or +service = project.services.get(service_name='asana', project_id=1) +# display it's status (enabled/disabled) +print(service.active) +# end service get + +# service list +services = gl.project_services.available() +# end service list + +# service update +service.api_key = 'randomkey' +service.save() +# end service update + +# service delete +service.delete() +# end service delete diff --git a/docs/gl_objects/projects.rst b/docs/gl_objects/projects.rst index af12025..5d8e61f 100644 --- a/docs/gl_objects/projects.rst +++ b/docs/gl_objects/projects.rst @@ -371,7 +371,7 @@ List the project hooks: :start-after: # hook list :end-before: # end hook list -Get a project hook +Get a project hook: .. literalinclude:: projects.py :start-after: # hook get @@ -394,3 +394,35 @@ Delete a project hook: .. literalinclude:: projects.py :start-after: # hook delete :end-before: # end hook delete + +Services +-------- + +Use :class:`~gitlab.objects.ProjectService` objects to manipulate projects +services. The :attr:`gitlab.Gitlab.project_services` and +:attr:`Project.services <gitlab.objects.Projects.services>` manager objects +provide helper functions. + +Get a service: + +.. literalinclude:: projects.py + :start-after: # service get + :end-before: # end service get + +List the code names of available services (doesn't return objects): + +.. literalinclude:: projects.py + :start-after: # service list + :end-before: # end service list + +Configure and enable a service: + +.. literalinclude:: projects.py + :start-after: # service update + :end-before: # end service update + +Disable a service: + +.. literalinclude:: projects.py + :start-after: # service delete + :end-before: # end service delete |