Merge pull request #4131 from nebulab/kennyadsl/document-rest-api-nested

Document REST API params to control nested taxons
solidusio · Jul 14, 2021 · 7b64d0c · 7b64d0c
2 parents abdd013 + 38073ae
commit 7b64d0c
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/api/openapi/solidus-api.oas.yml b/api/openapi/solidus-api.oas.yml
@@ -3747,6 +3747,13 @@ paths:
         - Taxonomies
       security:
         - api-key: []
+      parameters:
+        - schema:
+            type: string
+            default: nested
+          in: query
+          name: set
+          description: When `set=nested` it will recoursively return all the taxons of that taxonomy
     parameters:
       - name: id
         in: path
@@ -4005,6 +4012,11 @@ paths:
         - $ref: '#/components/parameters/page'
         - $ref: '#/components/parameters/per_page'
         - $ref: '#/components/parameters/q'
+        - schema:
+            type: boolean
+          in: query
+          name: without_children
+          description: 'When set to `true`, it won''t recursively return all the taxons'' children.'
       security:
         - api-key: []
   /users: