Fixes #38114 - Document path-id param for environment create (#11268)

Katello · Dec 20, 2024 · dbfa2ef · dbfa2ef
1 parent 81742d9
commit dbfa2ef
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/app/controllers/katello/api/v2/environments_controller.rb b/app/controllers/katello/api/v2/environments_controller.rb
@@ -84,6 +84,10 @@ def show
       ID of an environment that is prior to the new environment in the chain. It has to be
       either the ID of Library or the ID of an environment at the end of a chain.
     DESC
+    param :path_id, Integer, :desc => <<-DESC
+      If you are adding an environment to an existing path after Library, pass the ID of the environment that is the current successor of Library in the path.
+      It has to be the id of the old environment following library in this path.
+    DESC
     def create
       create_params = environment_params
       create_params[:label] = labelize_params(create_params)