gitlab-ruby 0.1.1.pre → 0.1.2.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 69eaed3eb91232c2aecbb26b98be4cd5a29fde24248e10a852f659516bb247d0
-  data.tar.gz: 1725f8b68db38f3f053e27ff55337401c052b88d01e84831ffd8992389b6b3bc
+  metadata.gz: e9fc5e454452048fc79a20d450ed567323818fdd213e767e67652bb041d48d11
+  data.tar.gz: 2f3ec5f9c534bbb9e09233bdd3a36cac11e8a6007707cb42ea2361d446460490
 SHA512:
-  metadata.gz: 82624e6e5b3c2ea05b39741e860b28c002ad9d1e1da63143987c7737cfed894521a65732f2feaabcf011f706fdf4edfd5746e1cfc04305ab5f0cb327229f9680
-  data.tar.gz: 86991c0381614452da9f14f7f7e1e8ff250a82bc4286060b222f069a72b2a23f3107f7f13f64ab160245284d5462dafc7460bf3642fbd3e3d5d03f09c3dad216
+  metadata.gz: b88602bafda9e419bdb24ac21fcdc7a266b732bc1d4a6f953aea46ca9be3be89fc1fbf8a06820b4055b702cb7e9b7274d495ae471a71cd5e4137539823ba9a37
+  data.tar.gz: b2abc4a4474533e49527f7ad779dfdd599f3dd610cf14061959b65b4bde8df98c833972d598ced86116278f341250fcc19407b621096713cf34ebc619d1310ef

data/lib/gitlab/api/issues.rb

@@ -1,18 +1,45 @@
 module Gitlab
   module Api
+    ##
+    # Issues api client
+    # @see https://docs.gitlab.com/ee/api/issues.html
+    #
     class Issues < Api::Base
       PATH = 'issues'
 
+      ##
+      # Retrieve all issues user has access to
+      #
+      # @see https://docs.gitlab.com/ee/api/issues.html#list-issues
+      # @param args [Hash] Arguments to pass to gitlab
+      # @return [Gitlab::Response]
+      #
       def list(args = {})
         action = with_pagination(args) { connection.get(PATH, args) }
         handle_action(action)
       end
 
+      ##
+      # Retrieve all issues within a group
+      #
+      # @see https://docs.gitlab.com/ee/api/issues.html#list-group-issues
+      # @param group [String] The group to get issues for
+      # @param args [Hash] Arguments to pass to gitlab
+      # @return [Gitlab::Response]
+      #
       def list_group(group, args = {})
         action = with_pagination(args) { connection.get(group_path(group), args) }
         handle_action(action)
       end
 
+      ##
+      # Retrieve all issues within a project
+      #
+      # @see https://docs.gitlab.com/ee/api/issues.html#list-project-issues
+      # @param project [String] The project to get issues for
+      # @param args [Hash] Arguments to pass to gitlab
+      # @return [Gitlab::Response]
+      #
       def list_project(project, args = {})
         action = with_pagination(args) { connection.get(project_path(project), args) }
         handle_action(action)

data/lib/gitlab/version.rb

@@ -1,3 +1,3 @@
 module Gitlab
-  VERSION = "0.1.1.pre"
+  VERSION = "0.1.2.pre"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.1.pre
+  version: 0.1.2.pre
 platform: ruby
 authors:
 - Taylor Scott