updated docs

Signed-off-by: Tobias Trozowski <tobias@trozowski.com>
mezzio · Dec 21, 2020 · 9027d04 · 9027d04
1 parent 068c41d
commit 9027d04
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 1 deletion.
diff --git a/docs/book/cookbook/generating-custom-resources.md b/docs/book/cookbook/generating-custom-resources.md
@@ -22,7 +22,8 @@ interface StrategyInterface
         $instance,
         Metadata\AbstractMetadata $metadata,
         ResourceGenerator $resourceGenerator,
-        ServerRequestInterface $request
+        ServerRequestInterface $request,
+        int $depth = 0
     ) : HalResource;
 }
 ```

diff --git a/docs/book/factories.md b/docs/book/factories.md
@@ -111,6 +111,7 @@ The additional pairs are as follows:
     - `route_params`: an array of additional routing parameters to use when
       generating the self relational link for the resource.
     - `identifiers_to_placeholders_mapping` (associative array mapping resource properties to routing parameters, for use when generating the URI; since 1.4.0)
+    - `max_depth`: the number of nesting levels processed. Defaults to 10.
 - For `RouteBasedCollectionMetadata`:
     - `collection_class`: the collection class the metadata describes.
     - `collection_relation`: the embedded relation for the collection in the

diff --git a/docs/book/resource-generator.md b/docs/book/resource-generator.md
@@ -52,6 +52,7 @@ following information:
     - array `$routeParams = []` (associative array of additional routing
       parameters to substitute when generating the URI)
     - array `$identifiersToPlacholdersMapping = []` (associative array mapping resource properties to route parameters, for use when generating the URI; available since 1.4.0)
+    - int `$maxDepth = 10` max allowed nesting levels.
 - `Mezzio\Hal\Metadata\UrlBasedCollectionMetadata`:
     - string `$class`
     - string `$collectionRelation`