@@ -24,6 +24,7 @@ class HookEvent(Enum):
2424 for interactive services.
2525
2626 Parameters:
27+
2728 - Comma-seperated list of names that are about to be started
2829 """
2930
@@ -37,6 +38,7 @@ class HookEvent(Enum):
3738 for interactive services.
3839
3940 Parameters:
41+
4042 - Comma-seperated list of names that were requested to be started and are now started
4143 """
4244
@@ -47,6 +49,7 @@ class HookEvent(Enum):
4749 .. warning:: Hooks are NOT executed if the Proxy Server stops a project.
4850
4951 Parameters:
52+
5053 - Comma-seperated list of names that are about to be stopped
5154 """
5255
@@ -58,6 +61,7 @@ class HookEvent(Enum):
5861 .. warning:: Hooks are NOT executed if the Proxy Server stops a project.
5962
6063 Parameters:
64+
6165 - Comma-seperated list of names that are now stopped (including services that were already stopped)
6266 """
6367
@@ -67,6 +71,7 @@ class HookEvent(Enum):
6771 command that switched the environment).
6872
6973 Parameters:
74+
7075 - Currently active database environment name
7176 - Database environment name requested to switch to
7277 """
@@ -76,6 +81,7 @@ class HookEvent(Enum):
7681 Hook is run before Riptide switches database environments when using ``riptide db-switch``.
7782
7883 Parameters:
84+
7985 - Name of database environment that was switched to
8086 """
8187
@@ -84,6 +90,7 @@ class HookEvent(Enum):
8490 Hook is run before Riptide created a new blank database environment when using ``riptide db-new``.
8591
8692 Parameters:
93+
8794 - Name of database environment that is about to be created
8895 """
8996
@@ -93,6 +100,7 @@ class HookEvent(Enum):
93100 Riptide has switched to this new environment.
94101
95102 Parameters:
103+
96104 - Name of database environment that was created
97105 """
98106
@@ -102,6 +110,7 @@ class HookEvent(Enum):
102110 or ``riptide setup``.
103111
104112 Parameters:
113+
105114 - Currently active database environment name
106115 - Path to the file to import (for hook commands this file is mounted)
107116 """
@@ -111,6 +120,7 @@ class HookEvent(Enum):
111120 Hook is run after Riptide imported a file into a database environment when using ``riptide db-import``.
112121
113122 Parameters:
123+
114124 - Currently active database environment name
115125 - Path to the imported file (for hook commands this file is mounted)
116126 """
@@ -120,6 +130,7 @@ class HookEvent(Enum):
120130 Hook is run before Riptide exports a file from a database environment when using ``riptide db-export``.
121131
122132 Parameters:
133+
123134 - Database environment name
124135 """
125136
@@ -128,6 +139,7 @@ class HookEvent(Enum):
128139 Hook is run after Riptide exported a file from a database environment when using ``riptide db-export``.
129140
130141 Parameters:
142+
131143 - Database environment name
132144 - Path to the file that contains the exported data (for hook commands this file is mounted)
133145 """
@@ -137,6 +149,7 @@ class HookEvent(Enum):
137149 Hook is run before Riptide copied a database environment when using ``riptide db-copy``.
138150
139151 Parameters:
152+
140153 - Name of database environment that is being copied from
141154 - Name of database environment that is being copied to
142155 """
@@ -147,6 +160,7 @@ class HookEvent(Enum):
147160 Riptide has switched to this new environment.
148161
149162 Parameters:
163+
150164 - Name of database environment that was being copied from
151165 - Name of database environment that was being copied to
152166 """
@@ -156,6 +170,7 @@ class HookEvent(Enum):
156170 Hook is run before Riptide imports a file into the project when using ``riptide import-files``.
157171
158172 Parameters:
173+
159174 - Key of the import definition
160175 - Path to the file to import (for hook commands this file is mounted)
161176 """
@@ -166,6 +181,7 @@ class HookEvent(Enum):
166181 or ``riptide setup``.
167182
168183 Parameters:
184+
169185 - Key of the import definition
170186 - Path to the imported file (for hook commands this file is mounted)
171187 """
@@ -182,6 +198,7 @@ class HookEvent(Enum):
182198 Hook is run at the end of the interactive setup wizard when using ``riptide setup``.
183199
184200 Parameters:
201+
185202 - ``new-project`` if the wizard was run in "new project" mode, ``existing-project`` otherwise
186203 """
187204
0 commit comments