From a8aec44d7330d428231ef7aa514483a0734e6914 Mon Sep 17 00:00:00 2001
From: khaledk2 <khaledk2@hotmail.com>
Date: Tue, 26 Nov 2024 19:10:28 +0000
Subject: [PATCH] add example to the documentation

---
 .../swagger_docs/sub_container_images.yml     | 37 ++++++++++++++++++-
 1 file changed, 35 insertions(+), 2 deletions(-)

diff --git a/omero_search_engine/api/v1/resources/swagger_docs/sub_container_images.yml b/omero_search_engine/api/v1/resources/swagger_docs/sub_container_images.yml
index 2d6c18e..8844be2 100644
--- a/omero_search_engine/api/v1/resources/swagger_docs/sub_container_images.yml
+++ b/omero_search_engine/api/v1/resources/swagger_docs/sub_container_images.yml
@@ -1,5 +1,38 @@
-A searchengine endpoint to return the available sub-container in a container (e.g. dataset in project)
-A query can be provided to return only the search results
+A searchengine endpoint to return the available sub-container in a container (e.g. dataset in project).
+A query can be provided to return only the search results.
+This a query example:
+{
+  "resource": "image",
+  "query_details": {
+    "and_filters": [
+      {
+        "name": "Organism",
+        "value": "homo sapiens",
+        "operator": "equals",
+        "resource": "image"
+      },
+      {
+        "name": "Gene symbol",
+        "value": "AC240274.1",
+        "operator": "contains",
+        "resource": "image"
+      },
+      {
+        "name": "Organism part",
+        "value": "Brain",
+        "operator": "equals",
+        "resource": "image"
+      }
+    ],
+    "or_filters": [
+
+    ],
+    "case_sensitive": false
+  }
+}
+and the user should provide the container nane, e.g,idr0043-uhlen-humanproteinatlas/experimentA
+and the container type which is project
+This will return the dataset inside the project with several images in each, this is within the search results.
 ---
 tags:
   - Available sub-containers inside a container