aboutsummaryrefslogtreecommitdiffstats
path: root/doc/src/guide/constraints.asciidoc
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2025-02-10 11:24:45 +0100
committerLoïc Hoguin <[email protected]>2025-02-10 11:24:45 +0100
commit971684788d991d98fc86e84d061a52809df76e2b (patch)
treee27a965627d82dfea176fbaf10176c63066637db /doc/src/guide/constraints.asciidoc
parent72b57a846dbacf7ea886b303c680c683a2acec5d (diff)
downloadcowboy-971684788d991d98fc86e84d061a52809df76e2b.tar.gz
cowboy-971684788d991d98fc86e84d061a52809df76e2b.tar.bz2
cowboy-971684788d991d98fc86e84d061a52809df76e2b.zip
Clarify that reverse/format_error constraint ops are experimental
Diffstat (limited to 'doc/src/guide/constraints.asciidoc')
-rw-r--r--doc/src/guide/constraints.asciidoc5
1 files changed, 5 insertions, 0 deletions
diff --git a/doc/src/guide/constraints.asciidoc b/doc/src/guide/constraints.asciidoc
index 6cc1075..4eade8a 100644
--- a/doc/src/guide/constraints.asciidoc
+++ b/doc/src/guide/constraints.asciidoc
@@ -91,6 +91,11 @@ int(forward, Value) ->
The value must be returned even if it is not converted
by the constraint.
+The two other operations are currently experimental. They are
+meant to help implement HATEOAS type services, but proper
+support for HATEOAS is not expected to be available before
+Cowboy 3.0 because of Cowboy's current router's limitations.
+
The `reverse` operation does the opposite: it
takes a converted value and changes it back to what the
user input would have been.