my_api_client 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9a7c0e59912fcb57831b996cda5b2d18d6488e33609eac9c1cc227b8d2699177
-  data.tar.gz: 6cf555c678a2537db8fe85dfe2c6a98385c61d00b92bc4d931c3bfdfdf04442b
+  metadata.gz: 4f2745bef6aa2f95a58e0659bba49daa138d81e49378ff9d987fdd06084ee0aa
+  data.tar.gz: f0f60c9b581486f00b58a8f1cb204aa081460ae680f4a6d58a572017506d25d4
 SHA512:
-  metadata.gz: 289f20431d12e8c625e15da365c85607da2324cb4990f8ad100ef8fd31b1c1acd5dae6e964b20191ef4be3b98518b77c792e5a5616d4e506cf01407f5038f822
-  data.tar.gz: 61b0c21d3b43b5492d84bd6eb5107efcf4b7f6b8573685c9f85097276ae86c97ca27beb988d7482b864b17f18a8655a1e43251bb827de36e23a1aa46e314365f
+  metadata.gz: a88a53ab7b3f39f50725baba06db050946a6123e4bd39a26e7b8f49ae7618f37f7c49b9d31fbf5de94a35aaa3893e867ed017d551a1e5954cc126913e4edb56a
+  data.tar.gz: 493aaf7b296b8964d1a00307c1a1dc41730d894cc896fa4c6a6aa7d8c2fa5c5b15bf2c32ec6b55d15853bfe0fb34158e98db4763bbddd6ffe30e8bd86c6573f4

data/.circleci/config.yml

@@ -12,13 +12,13 @@ references:
   - &ruby_version
     ruby_version:
       type: enum
-      enum: &ruby_version_enum ["3.0", "3.1", "3.2"]
-      default: "3.2"
+      enum: &ruby_version_enum ["3.1", "3.2", "3.3"]
+      default: "3.3"
   - &rails_version
     rails_version:
       type: enum
-      enum: &rails_version_enum ["6.1", "7.0"]
-      default: "7.0"
+      enum: &rails_version_enum ["6.1", "7.0", "7.1", "7.2"]
+      default: "7.2"
   - &bundler_options
     bundler_options:
       type: string
@@ -252,7 +252,7 @@ jobs:
       - code-climate/install
       - code-climate/sum-coverage:
           input: codeclimate.*.json
-          parts: 12
+          parts: 24
       - code-climate/upload-coverage
   rubocop:
     executor: gem_executor
@@ -294,7 +294,7 @@ workflows:
               ruby_version: *ruby_version_enum
               rails_version: *rails_version_enum
       - test_api:
-          ruby_version: "3.2"
+          ruby_version: "3.2" # Ruby on Jets requires Ruby 2.5, 2.7 or 3.2
       - rubocop
       - yardoc
       - upload-coverage:

data/.rubocop.yml

@@ -2,11 +2,12 @@ require:
   - rubocop-performance
   - rubocop-rake
   - rubocop-rspec
+  - rubocop-rspec_rails
 
 inherit_from: .rubocop_todo.yml
 
 AllCops:
-  TargetRubyVersion: 3.0
+  TargetRubyVersion: 3.1
   NewCops: enable
   Exclude:
     - rails_app/**/*
@@ -49,7 +50,7 @@ RSpec/DescribeClass:
 RSpec/ExampleLength:
   Max: 10
 
-RSpec/FilePath:
+RSpec/SpecFilePathFormat:
   Exclude:
     - "spec/lib/my_api_client/integrations/**/*"
     - "spec/lib/my_api_client/errors/**/*"
@@ -64,6 +65,6 @@ RSpec/NestedGroups:
 RSpec/MultipleExpectations:
   Max: 4
 
-RSpec/Rails/HaveHttpStatus:
+RSpecRails/HaveHttpStatus:
   Exclude:
     - "my_api/spec/controllers/**/*"

data/.ruby-version

@@ -0,0 +1 @@
+3.1.6

data/CHANGELOG.md

@@ -1,5 +1,63 @@
 # Change log
 
+## v1.2.0 (Sep 06, 2024)
+
+### Feature
+
+- [#1048](https://github.com/ryz310/my_api_client/pull/1048) Support lazy evaluation for request headers and body parameters ([@ryz310](https://github.com/ryz310))
+  The API client allows lazy evaluation for request headers and body parameters.
+  For example, a time-limited token can be issued immediately before the request.
+
+  ```rb
+  class ExampleApiClient < MyApiClient::Base
+    def get_users
+      get 'users', headers: headers, query: { key: 'value' }
+    end
+
+    private
+
+    def headers
+      lambda do
+        new_access_token = issue_new_access_token!
+        {
+          'Content-Type': 'application/json;charset=UTF-8',
+          'Authorization': "Bearer #{new_access_token}",
+        }
+      end
+    end
+  end
+  ```
+
+### Misc
+
+- [#1049](https://github.com/ryz310/my_api_client/pull/1049) Update supporting ruby and rails versions ([@ryz310](https://github.com/ryz310))
+  Support Ruby 3.3, Rails 7.1 and 7.2
+  End of supporting Ruby 3.0 :wave:
+
+### Dependabot
+
+- [#982](https://github.com/ryz310/my_api_client/pull/982) Bump rspec from 3.12.0 to 3.13.0 ([@ryz310](https://github.com/ryz310))
+- [#1006](https://github.com/ryz310/my_api_client/pull/1006) Bump rake from 13.2.0 to 13.2.1 ([@ryz310](https://github.com/ryz310))
+- [#1018](https://github.com/ryz310/my_api_client/pull/1018) Bump bugsnag from 6.26.4 to 6.27.0 ([@ryz310](https://github.com/ryz310))
+- [#1020](https://github.com/ryz310/my_api_client/pull/1020) Bump webmock from 3.23.0 to 3.23.1 ([@ryz310](https://github.com/ryz310))
+- [#1031](https://github.com/ryz310/my_api_client/pull/1031) Bump rubocop-performance from 1.21.0 to 1.21.1 ([@ryz310](https://github.com/ryz310))
+- [#1032](https://github.com/ryz310/my_api_client/pull/1032) Bump bugsnag from 6.27.0 to 6.27.1 ([@ryz310](https://github.com/ryz310))
+- [#1043](https://github.com/ryz310/my_api_client/pull/1043) Bump rexml from 3.3.3 to 3.3.6 ([@ryz310](https://github.com/ryz310))
+- [#1045](https://github.com/ryz310/my_api_client/pull/1045) Bump activesupport from 7.1.3.4 to 7.1.4 ([@ryz310](https://github.com/ryz310))
+- [#1046](https://github.com/ryz310/my_api_client/pull/1046) Bump faraday from 2.10.1 to 2.11.0 ([@ryz310](https://github.com/ryz310))
+- [#1047](https://github.com/ryz310/my_api_client/pull/1047) Bump yard from 0.9.36 to 0.9.37 ([@ryz310](https://github.com/ryz310))
+
+## v1.1.0 (Jan 09, 2024)
+
+### Bugfix
+
+- [#970](https://github.com/ryz310/my_api_client/pull/970) Fix handling when the error changes after a retry ([@ashimomura](https://github.com/ashimomura))
+
+### Dependabot
+
+- [#965](https://github.com/ryz310/my_api_client/pull/965) Bump faraday from 2.7.12 to 2.8.1 ([@ryz310](https://github.com/ryz310))
+- [#972](https://github.com/ryz310/my_api_client/pull/972) Bump rubocop-performance from 1.19.1 to 1.20.2 ([@ryz310](https://github.com/ryz310))
+
 ## v1.0.0 (Dec 07, 2023)
 
 ### Feature

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    my_api_client (1.0.0)
+    my_api_client (1.2.0)
       activesupport (>= 6.1.0)
       faraday (>= 0.17.1)
       jsonpath
@@ -10,51 +10,54 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.1.2)
+    activesupport (7.2.1)
       base64
       bigdecimal
-      concurrent-ruby (~> 1.0, >= 1.0.2)
+      concurrent-ruby (~> 1.0, >= 1.3.1)
       connection_pool (>= 2.2.5)
       drb
       i18n (>= 1.6, < 2)
+      logger (>= 1.4.2)
       minitest (>= 5.1)
-      mutex_m
-      tzinfo (~> 2.0)
-    addressable (2.8.5)
-      public_suffix (>= 2.0.2, < 6.0)
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0, >= 2.0.5)
+    addressable (2.8.7)
+      public_suffix (>= 2.0.2, < 7.0)
     ast (2.4.2)
     base64 (0.2.0)
-    bigdecimal (3.1.4)
-    bugsnag (6.26.0)
+    bigdecimal (3.1.8)
+    bugsnag (6.27.1)
       concurrent-ruby (~> 1.0)
     byebug (11.1.3)
     coderay (1.1.3)
-    concurrent-ruby (1.2.2)
+    concurrent-ruby (1.3.4)
     connection_pool (2.4.1)
-    crack (0.4.5)
+    crack (1.0.0)
+      bigdecimal
       rexml
-    diff-lcs (1.5.0)
-    docile (1.4.0)
-    drb (2.2.0)
-      ruby2_keywords
-    faraday (2.7.12)
-      base64
-      faraday-net_http (>= 2.0, < 3.1)
-      ruby2_keywords (>= 0.0.4)
-    faraday-net_http (3.0.2)
-    hashdiff (1.0.1)
-    i18n (1.14.1)
+    diff-lcs (1.5.1)
+    docile (1.4.1)
+    drb (2.2.1)
+    faraday (2.11.0)
+      faraday-net_http (>= 2.0, < 3.4)
+      logger
+    faraday-net_http (3.3.0)
+      net-http
+    hashdiff (1.1.1)
+    i18n (1.14.5)
       concurrent-ruby (~> 1.0)
-    json (2.7.1)
+    json (2.7.2)
     jsonpath (1.1.5)
       multi_json
     language_server-protocol (3.17.0.3)
-    method_source (1.0.0)
-    minitest (5.20.0)
+    logger (1.6.1)
+    method_source (1.1.0)
+    minitest (5.25.1)
     multi_json (1.15.0)
-    mutex_m (0.2.0)
-    parallel (1.23.0)
-    parser (3.2.2.4)
+    net-http (0.4.1)
+      uri
+    parallel (1.26.3)
+    parser (3.3.5.0)
       ast (~> 2.4.1)
       racc
     pry (0.14.2)
@@ -63,58 +66,54 @@ GEM
     pry-byebug (3.10.1)
       byebug (~> 11.0)
       pry (>= 0.13, < 0.15)
-    public_suffix (5.0.4)
-    racc (1.7.3)
+    public_suffix (6.0.1)
+    racc (1.8.1)
     rainbow (3.1.1)
-    rake (13.1.0)
-    regexp_parser (2.8.3)
-    rexml (3.2.6)
-    rspec (3.12.0)
-      rspec-core (~> 3.12.0)
-      rspec-expectations (~> 3.12.0)
-      rspec-mocks (~> 3.12.0)
-    rspec-core (3.12.2)
-      rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.3)
+    rake (13.2.1)
+    regexp_parser (2.9.2)
+    rexml (3.3.7)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.1)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.6)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-support (3.12.1)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
     rspec_junit_formatter (0.6.0)
       rspec-core (>= 2, < 4, != 2.12.0)
-    rubocop (1.58.0)
+    rubocop (1.66.1)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 3.2.2.4)
+      parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.30.0, < 2.0)
+      regexp_parser (>= 2.4, < 3.0)
+      rubocop-ast (>= 1.32.2, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.30.0)
-      parser (>= 3.2.1.0)
-    rubocop-capybara (2.19.0)
-      rubocop (~> 1.41)
-    rubocop-factory_bot (2.24.0)
-      rubocop (~> 1.33)
-    rubocop-performance (1.19.1)
-      rubocop (>= 1.7.0, < 2.0)
-      rubocop-ast (>= 0.4.0)
+    rubocop-ast (1.32.3)
+      parser (>= 3.3.1.0)
+    rubocop-performance (1.21.1)
+      rubocop (>= 1.48.1, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-    rubocop-rspec (2.25.0)
-      rubocop (~> 1.40)
-      rubocop-capybara (~> 2.17)
-      rubocop-factory_bot (~> 2.22)
+    rubocop-rspec (3.0.4)
+      rubocop (~> 1.61)
+    rubocop-rspec_rails (2.30.0)
+      rubocop (~> 1.61)
+      rubocop-rspec (~> 3, >= 3.0.1)
     ruby-progressbar (1.13.0)
-    ruby2_keywords (0.0.5)
     sawyer (0.9.2)
       addressable (>= 2.3.5)
       faraday (>= 0.17.3, < 3)
+    securerandom (0.3.1)
     simplecov (0.22.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
@@ -124,11 +123,12 @@ GEM
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.5.0)
-    webmock (3.19.1)
+    uri (0.13.1)
+    webmock (3.23.1)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
-    yard (0.9.34)
+    yard (0.9.37)
 
 PLATFORMS
   ruby
@@ -145,6 +145,7 @@ DEPENDENCIES
   rubocop-performance
   rubocop-rake
   rubocop-rspec
+  rubocop-rspec_rails
   simplecov (= 0.22.0)
   webmock
   yard

data/README.jp.md

@@ -12,8 +12,8 @@ MyApiClient は API リクエストクラスを作成するための汎用的な
 
 ## Supported Versions
 
-- Ruby 3.0, 3.1, 3.2
-- Rails 6.1, 7.0
+- Ruby 3.1, 3.2, 3.3
+- Rails 6.1, 7.0, 7.1, 7.2
 
 ## Installation
 

data/README.md

@@ -16,8 +16,8 @@ It is supposed to be used in Ruby on Rails, but it is made to work in other envi
 
 ## Supported Versions
 
-- Ruby 3.0, 3.1, 3.2
-- Rails 6.1, 7.0
+- Ruby 3.1, 3.2, 3.3
+- Rails 6.1, 7.0, 7.1, 7.2
 
 ## Installation
 

data/example/api_clients/my_error_api_client.rb

@@ -23,7 +23,7 @@ class MyErrorApiClient < ApplicationApiClient
 
   # GET error/:code
   def get_error(code:)
-    get "error/#{code}", headers: headers
+    get "error/#{code}", headers:
   end
 
   private

data/example/api_clients/my_header_api_client.rb

@@ -24,7 +24,7 @@ class MyHeaderApiClient < ApplicationApiClient
   # @param second_header [String] X-Second-Header
   # @return [Sawyer::Resource]
   def get_header(first_header:, second_header:)
-    get 'header', headers: headers, query: {
+    get 'header', headers:, query: {
       'X-First-Header': first_header,
       'X-Second-Header': second_header,
     }.compact

data/example/api_clients/my_pagination_api_client.rb

@@ -8,13 +8,13 @@ class MyPaginationApiClient < ApplicationApiClient
   # Paging with JSONPath
   # GET pagination?page=1
   def paging_with_jsonpath
-    pget 'pagination', headers: headers, query: { page: 1 }, paging: '$.links.next'
+    pget 'pagination', headers:, query: { page: 1 }, paging: '$.links.next'
   end
 
   # Paging with Proc
   # GET pagination?page=1
   def paging_with_proc
-    pget 'pagination', headers: headers, query: { page: 1 }, paging: lambda { |response|
+    pget 'pagination', headers:, query: { page: 1 }, paging: lambda { |response|
       response.data.links.next
     }
   end

data/example/api_clients/my_rest_api_client.rb

@@ -8,36 +8,36 @@ class MyRestApiClient < ApplicationApiClient
   # GET rest
   def get_posts(order: :asc)
     order = :desc unless order == :asc
-    query = { order: order }
-    get 'rest', query: query, headers: headers
+    query = { order: }
+    get 'rest', query:, headers:
   end
 
   # GET rest/:id
   def get_post(id:)
-    get "rest/#{id}", headers: headers
+    get "rest/#{id}", headers:
   end
 
   # POST rest
   def post_post(title:)
-    body = { title: title }
-    post 'rest', body: body, headers: headers
+    body = { title: }
+    post 'rest', body:, headers:
   end
 
   # PUT rest/:id
   def put_post(id:, title:)
-    body = { title: title }
-    put "rest/#{id}", body: body, headers: headers
+    body = { title: }
+    put "rest/#{id}", body:, headers:
   end
 
   # PATCH rest/:id
   def patch_post(id:, title:)
-    body = { title: title }
-    patch "rest/#{id}", body: body, headers: headers
+    body = { title: }
+    patch "rest/#{id}", body:, headers:
   end
 
   # DELETE rest/:id
   def delete_post(id:)
-    delete "rest/#{id}", headers: headers
+    delete "rest/#{id}", headers:
   end
 
   private

data/example/api_clients/my_status_api_client.rb

@@ -11,7 +11,7 @@ class MyStatusApiClient < ApplicationApiClient
 
   # GET status/:status
   def get_status(status:)
-    get "status/#{status}", headers: headers
+    get "status/#{status}", headers:
   end
 
   private

data/gemfiles/rails_7.1.gemfile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+# This file was generated by Appraisal
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+gem 'activesupport', '~> 7.1.0'
+
+group :integrations, optional: true do
+  gem 'bugsnag', '>= 6.11.0'
+end
+
+gemspec

data/gemfiles/rails_7.2.gemfile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+# This file was generated by Appraisal
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+gem 'activesupport', '~> 7.2.0'
+
+group :integrations, optional: true do
+  gem 'bugsnag', '>= 6.11.0'
+end
+
+gemspec

data/lib/my_api_client/error_handling/generator.rb

@@ -84,7 +84,7 @@ module MyApiClient
                   "You can use options that: #{ARGUMENTS}"
           end
 
-          instance_variable_set("@_#{k}", v)
+          instance_variable_set(:"@_#{k}", v)
         end
       end
 

data/lib/my_api_client/error_handling.rb

@@ -50,7 +50,7 @@ module MyApiClient
 
         new_error_handlers = error_handlers.dup
         new_error_handlers << lambda { |instance, response|
-          Generator.call(**options.merge(instance: instance, response: response))
+          Generator.call(**options.merge(instance:, response:))
         }
         self.error_handlers = new_error_handlers
       end

data/lib/my_api_client/errors/network_error.rb

@@ -30,7 +30,7 @@ module MyApiClient
     #
     # @return [String] Contents as string
     def inspect
-      { error: original_error, params: params }.inspect
+      { error: original_error, params: }.inspect
     end
 
     # Generate metadata for bugsnag.

data/lib/my_api_client/errors.rb

@@ -23,7 +23,7 @@ module MyApiClient
     #
     # @return [String] Contents as string
     def inspect
-      { error: super, params: params }.inspect
+      { error: super, params: }.inspect
     end
   end
 end

data/lib/my_api_client/exceptions.rb

@@ -51,9 +51,20 @@ module MyApiClient
     end
 
     def retry_calling(wait)
-      Sleeper.call(wait: wait)
+      Sleeper.call(wait:)
       @retry_count += 1
       @retry_result = call(*args)
     end
+
+    # call the handler for exception
+    #
+    # @note
+    #   To avoid handling the exception of the retry origin on the second and subsequent retries,
+    #   make exception.cause visited.
+    # @override ActiveSupport::Rescuable#rescue_with_handler
+    # @param exception [Exception] Target exception
+    def rescue_with_handler(exception)
+      self.class.rescue_with_handler(exception, object: self, visited_exceptions: [exception.cause])
+    end
   end
 end

data/lib/my_api_client/params/params.rb

@@ -29,7 +29,7 @@ module MyApiClient
       #
       # @return [String] Contents as string
       def inspect
-        { request: request, response: response }.inspect
+        { request:, response: }.inspect
       end
 
       private

data/lib/my_api_client/params/request.rb

@@ -10,20 +10,20 @@ module MyApiClient
       #
       # @param method [Symbol] describe_method_here
       # @param uri [URI] describe_uri_here
-      # @param headers [Hash, nil] describe_headers_here
-      # @param body [Hash, nil] describe_body_here
+      # @param headers [Hash, Proc<Hash>, nil] describe_headers_here
+      # @param body [Hash, Proc<Hash>, nil] describe_body_here
       def initialize(method, uri, headers, body)
         @method = method
         @uri = uri
-        @headers = headers
-        @body = body
+        @headers = headers.is_a?(Proc) ? headers.call : headers
+        @body = body.is_a?(Proc) ? body.call : body
       end
 
       # Description of #to_sawyer_args
       #
       # @return [Array<Object>] Arguments for Sawyer::Agent#call
       def to_sawyer_args
-        [method, uri.to_s, body, { headers: headers }]
+        [method, uri.to_s, body, { headers: }]
       end
 
       # Generate metadata for bugsnag.
@@ -33,8 +33,8 @@ module MyApiClient
       def metadata
         {
           line: "#{method.upcase} #{uri}",
-          headers: headers,
-          body: body,
+          headers:,
+          body:,
         }.compact
       end
       alias to_bugsnag metadata
@@ -43,7 +43,7 @@ module MyApiClient
       #
       # @return [String] Contents as string
       def inspect
-        { method: method, uri: uri.to_s, headers: headers, body: body }.inspect
+        { method:, uri: uri.to_s, headers:, body: }.inspect
       end
     end
   end

data/lib/my_api_client/request/basic.rb

@@ -13,11 +13,11 @@ module MyApiClient
           # @param pathname [String]
           #   Pathname of the request target URL.
           #   It's joined with the defined by `endpoint`.
-          # @param headers [Hash, nil]
+          # @param headers [Hash, Proc<Hash>, nil]
           #   Request headers.
           # @param query [Hash, nil]
           #   Query string.
-          # @param body [Hash, nil]
+          # @param body [Hash, Proc<Hash>, nil]
           #   Request body. You should not specify it when use GET method.
           # @return [Sawyer::Resource]
           #   Response body instance if the block is not given.

data/lib/my_api_client/request/executor.rb

@@ -22,7 +22,7 @@ module MyApiClient
         @request_params = request_params
         @request_logger = request_logger
         faraday = Faraday.new(nil, faraday_options)
-        @agent = Sawyer::Agent.new('', faraday: faraday)
+        @agent = Sawyer::Agent.new('', faraday:)
       end
 
       private

data/lib/my_api_client/request/pagination.rb

@@ -11,12 +11,10 @@ module MyApiClient
       #   Pathname of the request target URL. It's joined with the defined by `endpoint`.
       # @param paging [String, Proc]
       #   Specify the pagination link path included in the response body as JsonPath expression
-      # @param headers [Hash, nil]
+      # @param headers [Hash, Proc<Hash>, nil]
       #   Request headers.
       # @param query [Hash, nil]
       #   Query string.
-      # @param body [Hash, nil]
-      #   Request body. You should not specify it when use GET method.
       # @return [Enumerator::Lazy]
       #   Yields the pagination API response.
       def pageable_get(pathname, paging:, headers: nil, query: nil)