Merge pull request #24 from acdh-oeaw/explore-samples-endpoint

Explore samples endpoint
acdh-oeaw · Apr 25, 2024 · c30dc76 · c30dc76
2 parents 8a135f3 + ebe8d5b
commit c30dc76
Show file tree

Hide file tree

Showing 3 changed files with 41 additions and 16 deletions.
diff --git a/.insomnia/ApiSpec/spc_8ea7cfbb1b844196a75f9766a024be57.yml b/.insomnia/ApiSpec/spc_8ea7cfbb1b844196a75f9766a024be57.yml
@@ -1,7 +1,7 @@
 _id: spc_8ea7cfbb1b844196a75f9766a024be57
 type: ApiSpec
 parentId: wrk_6915256f54c24d51aa934588fd7b49ff
-modified: 1713205370542
+modified: 1713702349323
 created: 1675182326019
 fileName: Current Vicav API 1.0.0
 contents: >-
@@ -1593,23 +1593,31 @@ contents: >-
       get:
         tags:
           - noauth
-        summary: gets a specific html transformed via a specified xslt
+        summary: Search sample texts or feature lists by keyword or meatadata and return a rendered list of matching sentences.
         operationId: getExploreSamples
         description: |
           By passing the appropriate xml-ID and xslt you can retrieve ready to display html
         parameters:
           - in: query
             name: type
-            description: the type of query?
+            description: collection to query eg. vicav_lingfeatures
             required: true
             schema:
               type: string
           - in: query
             name: word
-            description: the word to search for?
-            required: true
+            description: the word to search for
+            required: false
             schema:
               type: string
+          - in: query
+            name: person
+            description: only search specific speakers info
+            required: true
+            schema:
+              type: false
+
+
           - in: query
             name: xslt
             required: false
@@ -3212,7 +3220,7 @@ contents: >-
                   $ref: '#/components/schemas/FeatureCollection'
               table:
                 type: array
-                itmes:
+                items:
                   type: object
       logo_type:
         type: object

diff --git a/openapi.json b/openapi.json
@@ -1305,14 +1305,14 @@
         "tags": [
           "noauth"
         ],
-        "summary": "gets a specific html transformed via a specified xslt",
+        "summary": "Search sample texts or feature lists by keyword or meatadata and return a rendered list of matching sentences.",
         "operationId": "getExploreSamples",
         "description": "By passing the appropriate xml-ID and xslt you can retrieve ready to display html\n",
         "parameters": [
           {
             "in": "query",
             "name": "type",
-            "description": "the type of query?",
+            "description": "collection to query eg. vicav_lingfeatures",
             "required": true,
             "schema": {
               "type": "string"
@@ -1321,12 +1321,21 @@
           {
             "in": "query",
             "name": "word",
-            "description": "the word to search for?",
-            "required": true,
+            "description": "the word to search for",
+            "required": false,
             "schema": {
               "type": "string"
             }
           },
+          {
+            "in": "query",
+            "name": "person",
+            "description": "only search specific speakers info",
+            "required": true,
+            "schema": {
+              "type": false
+            }
+          },
           {
             "in": "query",
             "name": "xslt",
@@ -2803,7 +2812,7 @@
               },
               "table": {
                 "type": "array",
-                "itmes": {
+                "items": {
                   "type": "object"
                 }
               }

diff --git a/openapi.yaml b/openapi.yaml
@@ -1584,23 +1584,31 @@ paths:
     get:
       tags:
         - noauth
-      summary: gets a specific html transformed via a specified xslt
+      summary: Search sample texts or feature lists by keyword or meatadata and return a rendered list of matching sentences.
       operationId: getExploreSamples
       description: |
         By passing the appropriate xml-ID and xslt you can retrieve ready to display html
       parameters:
         - in: query
           name: type
-          description: the type of query?
+          description: collection to query eg. vicav_lingfeatures
           required: true
           schema:
             type: string
         - in: query
           name: word
-          description: the word to search for?
-          required: true
+          description: the word to search for
+          required: false
           schema:
             type: string
+        - in: query
+          name: person
+          description: only search specific speakers info
+          required: true
+          schema:
+            type: false
+
+
         - in: query
           name: xslt
           required: false
@@ -3203,7 +3211,7 @@ components:
                 $ref: '#/components/schemas/FeatureCollection'
             table:
               type: array
-              itmes:
+              items:
                 type: object
     logo_type:
       type: object