diff options
| author | Gauvain Pocentek <gauvain@pocentek.net> | 2017-11-01 15:27:27 +0100 |
|---|---|---|
| committer | Gauvain Pocentek <gauvain@pocentek.net> | 2017-11-01 15:27:27 +0100 |
| commit | d415cc0929aed8bf95cbbb54f64d457e42d77696 (patch) | |
| tree | 60c63d8e511e84ed401c6d4c41221d72823f3251 | |
| parent | 5082879dcfbe322bb16e4c2387c25ec4f4407cb1 (diff) | |
| download | gitlab-d415cc0929aed8bf95cbbb54f64d457e42d77696.tar.gz | |
Update the repository_blob documentation
Fixes #312
| -rw-r--r-- | docs/gl_objects/projects.py | 5 | ||||
| -rw-r--r-- | docs/gl_objects/projects.rst | 2 | ||||
| -rw-r--r-- | gitlab/v4/objects.py | 4 |
3 files changed, 7 insertions, 4 deletions
diff --git a/docs/gl_objects/projects.py b/docs/gl_objects/projects.py index 6cdd260..4a6f3ad 100644 --- a/docs/gl_objects/projects.py +++ b/docs/gl_objects/projects.py @@ -142,7 +142,10 @@ items = project.repository_tree(path='docs', ref='branch1') # end repository tree # repository blob -file_content = p.repository_blob('master', 'README.rst') +items = project.repository_tree(path='docs', ref='branch1') +file_info = p.repository_blob(items[0]['id']) +content = base64.b64decode(file_info['content']) +size = file_info['size'] # end repository blob # repository raw_blob diff --git a/docs/gl_objects/projects.rst b/docs/gl_objects/projects.rst index 8465eb9..eb15a3b 100644 --- a/docs/gl_objects/projects.rst +++ b/docs/gl_objects/projects.rst @@ -120,7 +120,7 @@ List the repository tree: :start-after: # repository tree :end-before: # end repository tree -Get the content of a file for a commit: +Get the content and metadata of a file for a commit, using a blob sha: .. literalinclude:: projects.py :start-after: # repository blob diff --git a/gitlab/v4/objects.py b/gitlab/v4/objects.py index a57adff..5a3f17c 100644 --- a/gitlab/v4/objects.py +++ b/gitlab/v4/objects.py @@ -2024,7 +2024,7 @@ class Project(SaveMixin, ObjectDeleteMixin, RESTObject): @cli.register_custom_action('Project', ('sha', )) @exc.on_http_error(exc.GitlabGetError) def repository_blob(self, sha, **kwargs): - """Return a blob by blob SHA. + """Return a file by blob SHA. Args: sha(str): ID of the blob @@ -2035,7 +2035,7 @@ class Project(SaveMixin, ObjectDeleteMixin, RESTObject): GitlabGetError: If the server failed to perform the request Returns: - str: The blob metadata + dict: The blob content and metadata """ path = '/projects/%s/repository/blobs/%s' % (self.get_id(), sha) |