rails-param-validation 0.2.0 → 0.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/docs/annotations.md +4 -4
- data/lib/rails-param-validation/types/types.rb +4 -0
- data/lib/rails-param-validation/version.rb +1 -1
- metadata +1 -1
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 611940a379b0bcf38dae5ec17504074523e2a6d169669f0de05623380c6c0ed0
|
4
|
+
data.tar.gz: f3e7b0c51e9504a915a36d27b8f9e6289845046fa87d9e5b3d612cc18ca3a498
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 3eb0f67d39cda8c5737839abda8f720c559d9faf1062e5a873c8835eb98b9beeb988d461750f997705744eaf3f142376db5e5753d1f88495965126ad22ad9599
|
7
|
+
data.tar.gz: fe3696bdfef9b9697c838c26b6314810b0b7a9199da23bbdd874331ed20aca7d78824fd96c61fc4db75c8f9bb1073b61a23c962c72d6281df2f3731d18d84349
|
data/docs/annotations.md
CHANGED
@@ -24,15 +24,15 @@ end
|
|
24
24
|
|
25
25
|
**query_param**
|
26
26
|
|
27
|
-
Parameter passed via query string, e.g. `http://localhost/my_action?parameter=value`. The first value is the parameter name (which must be a symbol), the second is the [type definition](./
|
27
|
+
Parameter passed via query string, e.g. `http://localhost/my_action?parameter=value`. The first value is the parameter name (which must be a symbol), the second is the [type definition](./type-definition.md). The last (optional) parameter to this call is the description.
|
28
28
|
|
29
29
|
**path_param**
|
30
30
|
|
31
|
-
Parameter passed as part of the actions route, e.g. `http://localhost/my_action/value` where the route definition is something like `get '/my_action/:parameter, to: 'my_controller#my_action'`. The first value is the parameter name (which must be a symbol), the second is the [type definition](./
|
31
|
+
Parameter passed as part of the actions route, e.g. `http://localhost/my_action/value` where the route definition is something like `get '/my_action/:parameter, to: 'my_controller#my_action'`. The first value is the parameter name (which must be a symbol), the second is the [type definition](./type-definition.md). The last (optional) parameter to this call is the description.
|
32
32
|
|
33
33
|
**body_param**
|
34
34
|
|
35
|
-
Parameter as part of a JSON body in a POST/PUT/PATCH operation. The first value is the parameter name (which must be a symbol) as the JSON body must be a JSON object which has a key named like the parameter. The second parameter is the [type definition](./
|
35
|
+
Parameter as part of a JSON body in a POST/PUT/PATCH operation. The first value is the parameter name (which must be a symbol) as the JSON body must be a JSON object which has a key named like the parameter. The second parameter is the [type definition](./type-definition.md). The last (optional) parameter to this call is the description.
|
36
36
|
|
37
37
|
Example body:
|
38
38
|
|
@@ -55,7 +55,7 @@ end
|
|
55
55
|
|
56
56
|
**response**
|
57
57
|
|
58
|
-
The response annotation defines the possible responses the action can generate, where the first parameter is the HTTP status code, the second is the [type definition](./
|
58
|
+
The response annotation defines the possible responses the action can generate, where the first parameter is the HTTP status code, the second is the [type definition](./type-definition.md). The last (optional) parameter to this call is the description.
|
59
59
|
|
60
60
|
**accept_all_params**
|
61
61
|
|