From 813839bb9a9b15bc10d7598f89b19590736b496c Mon Sep 17 00:00:00 2001
From: Antony Wilson <antony.wilson@stfc.ac.uk>
Date: Wed, 12 Jun 2024 13:31:33 +0100
Subject: [PATCH] add alternate search end point examples

---
 mod_api/static/mod_api/openAPI.yaml | 54 +++++++++++++++++++++++++++++
 1 file changed, 54 insertions(+)

diff --git a/mod_api/static/mod_api/openAPI.yaml b/mod_api/static/mod_api/openAPI.yaml
index a8ee298..8fcbd85 100644
--- a/mod_api/static/mod_api/openAPI.yaml
+++ b/mod_api/static/mod_api/openAPI.yaml
@@ -1575,3 +1575,57 @@ paths:
           $ref: "#/components/responses/records"
         "404":
           $ref: "#/components/responses/error_message"
+
+  # Search all semantic artefacts
+  /search/artefacts:
+    parameters:
+      - $ref: "#/components/parameters/format_param"
+      - $ref: "#/components/parameters/query"
+
+    get:
+      tags:
+        - Search
+      summary: Get information about all semantic artefacts that match the search criteria.
+      description: Retrieves a collection of all semantic artefacts that match the search criteria.
+      operationId: searchArtefacts
+      responses:
+        "200":
+          $ref: "#/components/responses/artefacts"
+        "404":
+          $ref: "#/components/responses/error_message"
+
+  # Search all semantic artefact distributions
+  /search/distributions:
+    parameters:
+      - $ref: "#/components/parameters/format_param"
+      - $ref: "#/components/parameters/query"
+
+    get:
+      tags:
+        - Search
+      summary: Get information about all semantic artefact distributions that match the search criteria.
+      description: Retrieves a collection of semantic artefact distributions that match the search criteria.
+      operationId: searchCatalogueDistributions
+      responses:
+        "200":
+          $ref: "#/components/responses/distributions"
+        "404":
+          $ref: "#/components/responses/error_message"
+
+  # Search all semantic artefact catalog records
+  /search/records:
+    parameters:
+      - $ref: "#/components/parameters/format_param"
+      - $ref: "#/components/parameters/query"
+
+    get:
+      tags:
+        - Search
+      summary: Get information about all semantic artefact catalog records that match the search criteria.
+      description: Retrieves a collection of semantic artefact catalog records that match the search criteria.
+      operationId: searchCatalogueRecords
+      responses:
+        "200":
+          $ref: "#/components/responses/records"
+        "404":
+          $ref: "#/components/responses/error_message"
\ No newline at end of file