Merge branch 'hotfix/29'

Close #29

Author: weierophinney

docs/book/factories.md

@@ -126,6 +126,17 @@ support them. Create `create<type>(array $metadata)` methods for each
 type you wish to support, where `<type>` is your custom class name, minus
 the namespace.
 
+> ### Limitation
+> 
+> There is a [known limitation](https://github.com/zendframework/zend-expressive-hal/issues/5)
+> with zend-router when using routes with optional parameters (e.g., `/books[/:id]`,
+> where `:id` is optional). In such cases, if no matching parameter is provided
+> (such as when generating a URI without an `:id`), the router will raise an
+> exception due to the missing parameter.
+> 
+> If you encounter this issue, create separate routing entries for each optional
+> parameter. See the issue for a comprehensive example.
+
 ## Zend\Expressive\Hal\ResourceGeneratorFactory
 
 - Registered as service: `Zend\Expressive\Hal\ResourceGenerator`

docs/book/links-and-resources.md

@@ -142,6 +142,17 @@ $link = $linkGenerator->templatedFromRoute(
 If you need to generate custom links based on routing, we recommend composing
 the `LinkGenerator` in your own classes to do so.
 
+> ### Limitation
+> 
+> There is a [known limitation](https://github.com/zendframework/zend-expressive-hal/issues/5)
+> with zend-router when using routes with optional parameters (e.g., `/books[/:id]`,
+> where `:id` is optional). In such cases, if no matching parameter is provided
+> (such as when generating a URI without an `:id`), the router will raise an
+> exception due to the missing parameter.
+> 
+> If you encounter this issue, create separate routing entries for each optional
+> parameter. See the issue for a comprehensive example.
+
 ## Resources
 
 A HAL resource is simply the representation you want to return for your API.