[docs] Commits: add an example of binary file creation

Gauvain Pocentek · Gauvain Pocentek · commit c7b3f969fc3f · 2018-03-05T16:25:57.000+01:00
Binary files need to be encoded in base64. Fixes python-gitlab#427
diff --git a/docs/gl_objects/commits.py b/docs/gl_objects/commits.py
@@ -17,8 +17,15 @@
     'actions': [
         {
             'action': 'create',
-            'file_path': 'blah',
-            'content': 'blah'
+            'file_path': 'README.rst',
+            'content': open('path/to/file.rst').read(),
+        },
+        {
+            # Binary files need to be base64 encoded
+            'action': 'create',
+            'file_path': 'logo.png',
+            'content': base64.b64encode(open('logo.png').read()),
+            'encoding': 'base64',
         }
     ]
 }

Original file line number	Diff line number	Diff line change
`@@ -17,8 +17,15 @@`
`17`	`17`	`'actions': [`
`18`	`18`	`{`
`19`	`19`	`'action': 'create',`
`20`		`- 'file_path': 'blah',`
`21`		`- 'content': 'blah'`
	`20`	`+ 'file_path': 'README.rst',`
	`21`	`+ 'content': open('path/to/file.rst').read(),`
	`22`	`+ },`
	`23`	`+ {`
	`24`	`+ # Binary files need to be base64 encoded`
	`25`	`+ 'action': 'create',`
	`26`	`+ 'file_path': 'logo.png',`
	`27`	`+ 'content': base64.b64encode(open('logo.png').read()),`
	`28`	`+ 'encoding': 'base64',`
`22`	`29`	`}`
`23`	`30`	`]`
`24`	`31`	`}`