fix(snippets): allow passing list of files

nejch · JohnVillalovos · commit 31c3c5ea7cba · 2023-10-08T21:26:47.000-07:00
diff --git a/docs/gl_objects/projects.rst b/docs/gl_objects/projects.rst
@@ -566,8 +566,10 @@ Get the content of a snippet::
 Create a snippet::
 
     snippet = project.snippets.create({'title': 'sample 1',
-                                       'file_name': 'foo.py',
-                                       'code': 'import gitlab',
+                                       'files': [{
+                                            'file_path': 'foo.py',
+                                            'content': 'import gitlab'
+                                        }],
                                        'visibility_level':
                                        gitlab.const.Visibility.PRIVATE})
 
diff --git a/docs/gl_objects/snippets.rst b/docs/gl_objects/snippets.rst
@@ -39,8 +39,11 @@ Get a snippet::
 Create a snippet::
 
     snippet = gl.snippets.create({'title': 'snippet1',
-                                  'file_name': 'snippet1.py',
-                                  'content': open('snippet1.py').read()})
+                                  'files': [{
+                                      'file_path': 'foo.py',
+                                      'content': 'import gitlab'
+                                   }],
+                                })
 
 Update the snippet attributes::
 
diff --git a/gitlab/v4/objects/snippets.py b/gitlab/v4/objects/snippets.py
@@ -70,10 +70,23 @@ class SnippetManager(CRUDMixin, RESTManager):
     _path = "/snippets"
     _obj_cls = Snippet
     _create_attrs = RequiredOptional(
-        required=("title", "file_name", "content"), optional=("lifetime", "visibility")
+        required=("title",),
+        exclusive=("files", "file_name"),
+        optional=(
+            "description",
+            "content",
+            "visibility",
+        ),
     )
     _update_attrs = RequiredOptional(
-        optional=("title", "file_name", "content", "visibility")
+        optional=(
+            "title",
+            "files",
+            "file_name",
+            "content",
+            "visibility",
+            "description",
+        ),
     )
 
     @cli.register_custom_action("SnippetManager")
@@ -151,11 +164,22 @@ class ProjectSnippetManager(CRUDMixin, RESTManager):
     _obj_cls = ProjectSnippet
     _from_parent_attrs = {"project_id": "id"}
     _create_attrs = RequiredOptional(
-        required=("title", "file_name", "content", "visibility"),
-        optional=("description",),
+        required=("title", "visibility"),
+        exclusive=("files", "file_name"),
+        optional=(
+            "description",
+            "content",
+        ),
     )
     _update_attrs = RequiredOptional(
-        optional=("title", "file_name", "content", "visibility", "description"),
+        optional=(
+            "title",
+            "files",
+            "file_name",
+            "content",
+            "visibility",
+            "description",
+        ),
     )
 
     def get(
diff --git a/tests/functional/api/test_snippets.py b/tests/functional/api/test_snippets.py
@@ -6,7 +6,10 @@ def test_snippets(gl):
     assert not snippets
 
     snippet = gl.snippets.create(
-        {"title": "snippet1", "file_name": "snippet1.py", "content": "import gitlab"}
+        {
+            "title": "snippet1",
+            "files": [{"file_path": "snippet1.py", "content": "import gitlab"}],
+        }
     )
     snippet = gl.snippets.get(snippet.id)
     snippet.title = "updated_title"
@@ -30,8 +33,7 @@ def test_project_snippets(project):
     snippet = project.snippets.create(
         {
             "title": "snip1",
-            "file_name": "foo.py",
-            "content": "initial content",
+            "files": [{"file_path": "foo.py", "content": "initial content"}],
             "visibility": gitlab.const.VISIBILITY_PRIVATE,
         }
     )

Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,10 @@ def test_snippets(gl):`
`6`	`6`	`assert not snippets`
`7`	`7`
`8`	`8`	`snippet = gl.snippets.create(`
`9`		`- {"title": "snippet1", "file_name": "snippet1.py", "content": "import gitlab"}`
	`9`	`+ {`
	`10`	`+ "title": "snippet1",`
	`11`	`+ "files": [{"file_path": "snippet1.py", "content": "import gitlab"}],`
	`12`	`+ }`
`10`	`13`	`)`
`11`	`14`	`snippet = gl.snippets.get(snippet.id)`
`12`	`15`	`snippet.title = "updated_title"`
`@@ -30,8 +33,7 @@ def test_project_snippets(project):`
`30`	`33`	`snippet = project.snippets.create(`
`31`	`34`	`{`
`32`	`35`	`"title": "snip1",`
`33`		`- "file_name": "foo.py",`
`34`		`- "content": "initial content",`
	`36`	`+ "files": [{"file_path": "foo.py", "content": "initial content"}],`
`35`	`37`	`"visibility": gitlab.const.VISIBILITY_PRIVATE,`
`36`	`38`	`}`
`37`	`39`	`)`