Merge pull request #3088 from balena-io/fleets-by-org

API/resources: Add an example for retrieving the fleets of a specific organization

config/dictionaries/resource.json

@@ -23,10 +23,18 @@
       "created_at"
     ],
     "examples": [
+      {
+        "id": "get-all-apps-of-org-by-handle",
+        "summary": "Get all fleets of an organization by its HANDLE",
+        "description": "",
+        "method": "GET",
+        "endpoint": "/v6/application",
+        "filters": "?\\$filter=organization/any(o:o/handle%20eq%20%27<ORG_HANDLE>%27)"
+      },
       {
         "id": "get-all-apps",
         "summary": "Get all fleets",
-        "description": "",
+        "description": "Note: This will also include all public fleets of the platform. In most cases retrieving the fleets by their organization will be preferable.",
         "method": "GET",
         "endpoint": "/v6/application",
         "filters": ""