Merge pull request #865 from hubmapconsortium/shirey/param-search-doc…

…-update add jupyter notebook param search example
hubmapconsortium · Aug 28, 2024 · ee099bf · ee099bf
2 parents 2c01959 + 953bfb3
commit ee099bf
Show file tree

Hide file tree

Showing 3 changed files with 195 additions and 2 deletions.
diff --git a/.gitignore b/.gitignore
@@ -49,3 +49,6 @@ scripts/fresh_indices/fresh_indices.ini
 
 # The file holding the user's token, stream into the fresh_indices.sh script
 scripts/fresh_indices/token_holder
+
+examples/*.out
+examples/.ipynb_checkpoints/**/*
diff --git a/examples/Parameter Search and Download Tutorial.ipynb b/examples/Parameter Search and Download Tutorial.ipynb
diff --git a/search-api-spec.yaml b/search-api-spec.yaml
@@ -908,12 +908,12 @@ paths:
                   $ref: '#/components/schemas/SearchResponse'
         '303':
             description: If the total response payload exceeds 10 MB, the response is returned via an S3 bucket.  A 303 HTTP response code will be returned with the redirect URL where the query can be retrieved.
-        '400':
-            description: Bad request. A JSON body and appropriate Content-Type header are required in request
         '401':
             description:  A valid globus token in the `Authorization` header (Bearer scheme) is required in request
         '403':
           description: The globus token used in the `Authorization` header doesn't have the right group access permission
+        '404':
+            description: Bad request or no data found. A JSON body and appropriate Content-Type header are required in request, additionally if no data has been found based on the query when the produce-clt-manifest=true option is used.
         '504':
           description: There is a maximum query and response time of 30 seconds.  If the query response takes 30 seconds or longer, a 504 HTTP response code will be returned.