Define common helper for describe pagination params in api

1 files changed, 24 insertions, 0 deletions

diff --git a/lib/api/pagination_params.rb b/lib/api/pagination_params.rb
new file mode 100644
index 00000000000..8c1e4381a74
--- /dev/null
+++ b/lib/api/pagination_params.rb
@@ -0,0 +1,24 @@
+module API
+  # Concern for declare pagination params.
+  #
+  # @example
+  #   class CustomApiResource < Grape::API
+  #     include PaginationParams
+  #
+  #     params do
+  #       use :pagination
+  #     end
+  #   end
+  module PaginationParams
+    extend ActiveSupport::Concern
+
+    included do
+      helpers do
+        params :pagination do
+          optional :page, type: Integer, desc: 'Current page number'
+          optional :per_page, type: Integer, desc: 'Number of items per page'
+        end
+      end
+    end
+  end
+end