]> git.ipfire.org Git - thirdparty/bugzilla.git/commitdiff
no bug - Add syntax for dot accessors of component props
authorEmma Humphries <emceeaich@users.noreply.github.com>
Tue, 11 Feb 2020 01:23:55 +0000 (17:23 -0800)
committerGitHub <noreply@github.com>
Tue, 11 Feb 2020 01:23:55 +0000 (20:23 -0500)
docs/en/rst/api/core/v1/product.rst

index 0b96f782397ba667a9a51eb4cef1d06d37823139..6a285aed4c8e5ed14fe033eefb3ff63a2ac6a49a 100644 (file)
@@ -266,6 +266,13 @@ request_group     int      The group ID that is allowed to request the flag if
                            flagtype.
 ================  =======  ======================================================
 
+To return information about components in products, you can use the 
+``.`` property accesssor in your request: 
+
+.. code-block:: text
+
+   /rest/product?type=enterable&include_fields=id,name,components.name,components.id,components.is_active,components.description
+
 .. _rest_product_create:
 
 Create Product