Added comments describing the reasons that tests fail.

spec/controllers/apipies_controller_spec.rb

@@ -42,6 +42,7 @@
     end
 
     it "returns not_found on wrong method" do
+      # This spec fails because a get url parameter cannot be named method.
       get :index, :version => "2.0", :resource => "architectures", :method => "wrong_method"
 
       assert_response :not_found
@@ -225,6 +226,8 @@
       expect(response.body).to eq("apidoc.json cache")
       get :index, :version => 'v1', :format => "html", :resource => "resource"
       expect(response.body).to eq("resource.html cache")
+      # get parameters cannot have the name method. Rails was built in such a way that this is a
+      # reserved keyword. As a result, this get request fails.
       get :index, :version => 'v1', :format => "html", :resource => "resource", :method => "method"
       expect(response.body).to eq("method.html cache")
     end

spec/controllers/concerns_controller_spec.rb

@@ -22,6 +22,9 @@
   end
 
   it "replaces a placeholder doc specified in concern with a real path" do
+    # This spec fails due to the failure of the api! dsl method.
+    # See the controller for the replacement line (without api!)
+    # that works.
     path = Apipie["concern_resources#index"].apis.first.path
     expect(path).to eq('/api/concerns')
 

spec/controllers/users_controller_spec.rb

@@ -389,6 +389,10 @@ def reload_controllers
     context "Using routes.rb" do
       it "should contain basic info about method" do
         a = Apipie[UsersController, :create_route]
+        # the spec below fails due to the fact that the api!
+        # dsl syntax is used. This portion of the dsl does not
+        # seem to be currently compatible with Rails 5.x.x.x
+        # routing.
         expect(a.apis.count).to eq(1)
         expect(a.formats).to eq(['json'])
         api = a.apis.first

spec/dummy/app/controllers/concerns/sample_controller.rb

@@ -2,6 +2,10 @@ module Concerns
   module SampleController
     extend Apipie::DSL::Concern
 
+    # Spec fails due to failure of the api! method.
+    # spec/controllers/concerns_controller_spec.rb:24 would pass if api!
+    # were replaced with the following line.
+    # api :GET, '/api/concerns'
     api!
     def index
       render :text => "OK #{params.inspect}"

spec/dummy/app/controllers/users_controller.rb

@@ -272,6 +272,10 @@ def desc_from_file
     render :text => 'document from file action'
   end
 
+  # Spec spec/controllers/users_controller_spec.rb:396
+  # fails due to use of api!. The spec would get further and almost pass
+  # if it was replaced with the following.
+  # api :POST, "/api/users/create_route", "Create user"
   api! 'Create user using create_route'
   param_group :user
   param :user, Hash do