Merge pull request #4 from NASA-AMMOS/dev/plan-search-examples

Examples of finding plans by contents

Author: dandelany

docs/api/examples/plan-search.mdx

@@ -0,0 +1,90 @@
+# Plan Search
+
+## Query for Plans with a Specific Activity Directive Type
+
+The query below retrieves all plans that contain an activity directive of a specified type (e.g., "GenerateData"):
+
+```graphql
+query QueryPlansWithActivityType {
+  plan(where: { activity_directives: { type: { _eq: "GenerateData" } } }) {
+    id
+    name
+    activity_directives {
+      type
+      arguments
+    }
+  }
+}
+```
+
+## Query for Plans with Activity Directives with a Specific Argument Name
+
+The query below retrieves all plans that contain an activity directive with a specific argument name (e.g., "bin"):
+
+```graphql
+query QueryPlansWithArgumentName {
+  plan(where: { activity_directives: { arguments: { _has_key: "bin" } } }) {
+    id
+    name
+    activity_directives {
+      type
+      arguments
+    }
+  }
+}
+```
+
+## Query for Plans with Activity Directives with a Specific Argument Value
+
+The query below and the variables that follow retrieves all plans that contain an activity directive with a specific argument value (e.g., "bin" equal to 20):
+
+```graphql
+query QueryByArgValue($argPair: jsonb) {
+  plan(where: { activity_directives: { arguments: { _contains: $argPair } } }) {
+    id
+    name
+    activity_directives {
+      type
+      arguments
+    }
+  }
+}
+```
+
+### Variables
+
+```json
+{
+  "argPair": {
+    "bin": 20
+  }
+}
+```
+
+# Activity Directive Search
+
+## Query for Activity Directives with a Specific Activity Type
+
+```graphql
+query QueryPlansWithActivityType {
+  activity_directive(where: { type: { _eq: "GenerateData" } }) {
+    id
+    type
+    plan_id
+  }
+}
+```
+
+## Query for Activity Directives with a Specific Argument Value Across All Plans
+
+The query below retrieves all activity directives across all plans that have a specific argument substring present (e.g., "thrust"):
+
+```graphql
+query QueryPlansWithParameterSubstring {
+  activity_directive(where: { arguments: { _cast: { String: { _ilike: "%thrust%" } } } }) {
+    id
+    plan_id
+    arguments
+  }
+}
+```

sidebars.js

@@ -22,7 +22,7 @@ const sidebars = {
           items: [
             'api/examples/planning/collaboration',
             'api/examples/planning/anchors',
-            'api/examples/planning/snapshots'
+            'api/examples/planning/snapshots',
           ],
         },
         'api/examples/simulation',
@@ -32,6 +32,7 @@ const sidebars = {
         'api/examples/advanced-extensions',
         'api/examples/tags',
         'api/examples/external-events',
+        'api/examples/plan-search',
       ],
     },
   ],
@@ -74,7 +75,7 @@ const sidebars = {
             'overview/design/software-design-document',
           ],
         },
-        'overview/aerie-renamed-to-plandev'
+        'overview/aerie-renamed-to-plandev',
       ],
     },
     {