(PXP-5529): implement GET /objects endpoint

docs/openapi.yaml

@@ -409,6 +409,63 @@ paths:
       tags:
       - Index
   /objects:
+    get:
+      description: XXX comments
+      operationId: get_objects_objects_get
+      parameters:
+      - description: Switch to returning a list of GUIDs (false), or GUIDs mapping
+          to their metadata (true).
+        in: query
+        name: data
+        required: false
+        schema:
+          default: false
+          description: Switch to returning a list of GUIDs (false), or GUIDs mapping
+            to their metadata (true).
+          title: Data
+          type: boolean
+      - description: 'Maximum number of records returned. (max: 2000)'
+        in: query
+        name: limit
+        required: false
+        schema:
+          default: 10
+          description: 'Maximum number of records returned. (max: 2000)'
+          title: Limit
+          type: integer
+      - description: Return results at this given offset.
+        in: query
+        name: offset
+        required: false
+        schema:
+          default: 0
+          description: Return results at this given offset.
+          title: Offset
+          type: integer
+      - description: Filters to apply.
+        in: query
+        name: filter
+        required: false
+        schema:
+          default: ''
+          description: Filters to apply.
+          title: Filter
+          type: string
+      responses:
+        '200':
+          content:
+            application/json:
+              schema: {}
+          description: Successful Response
+        '422':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/HTTPValidationError'
+          description: Validation Error
+      summary: Get Objects
+      tags:
+      - Object
     post:
       description: "Create object placeholder and attach metadata, return Upload url\
         \ to the user.\n\nArgs:\n    body (CreateObjInput): input body for create\

pyproject.toml

@@ -18,6 +18,7 @@ indexclient = "^2.1.0"
 httpx = "^0.12.1"
 authutils = "^5.0.4"
 cdislogging = "^1.0.0"
+parsimonious = "0.8.1"
 
 [tool.poetry.dev-dependencies]
 pytest = "^5.3"

src/mds/objects.py

@@ -3,7 +3,7 @@
 
 from authutils.token.fastapi import access_token
 from asyncpg import UniqueViolationError
-from fastapi import HTTPException, APIRouter, Security
+from fastapi import HTTPException, APIRouter, Security, Query
 from fastapi.security import HTTPBearer, HTTPAuthorizationCredentials
 import httpx
 from pydantic import BaseModel
@@ -22,7 +22,7 @@
 
 from . import config, logger
 from .models import Metadata
-from .query import get_metadata
+from .query import get_metadata, search_metadata_helper
 
 mod = APIRouter()
 
@@ -226,6 +226,73 @@ async def create_object_for_id(
     return JSONResponse(response, HTTP_201_CREATED)
 
 
+@mod.get("/objects")
+async def get_objects(
+    request: Request,
+    #  XXX would be nice to be able to specify whether to return indexd records
+    #  (e.g GET objects?data=metadata would only return mds objects)
+    data: bool = Query(
+        False,
+        description="Switch to returning a list of GUIDs (false), "
+        "or GUIDs mapping to their metadata (true).",
+    ),
+    limit: int = Query(
+        10, description="Maximum number of records returned. (max: 2000)"
+    ),
+    offset: int = Query(0, description="Return results at this given offset."),
+    #  XXX description
+    #  XXX how to name this python variable something other than filter but
+    #  still have client use "filter" as URL query param? (bc filter is already
+    #  built in to Python)
+    filter: str = Query("", description="Filters to apply."),
+) -> JSONResponse:
+    """
+    XXX comments
+    """
+
+    metadata_objects = await search_metadata_helper(
+        data=data, limit=limit, offset=offset, filter=filter
+    )
+
+    records = {}
+    if metadata_objects:
+        try:
+            endpoint_path = "/bulk/documents"
+            full_endpoint = config.INDEXING_SERVICE_ENDPOINT.rstrip("/") + endpoint_path
+            guids = (
+                list(metadata_objects.keys())
+                if hasattr(metadata_objects, "keys")
+                else metadata_objects
+            )
+            #  XXX /bulk/documents endpoint in indexd currently doesn't support
+            #  filters
+            response = await request.app.async_client.post(full_endpoint, json=guids)
+            response.raise_for_status()
+            records = {r["did"]: r for r in response.json()}
+        except httpx.HTTPError as err:
+            logger.debug(err, exc_info=True)
+            if err.response:
+                logger.error(
+                    "indexd `POST %s` endpoint returned a %s HTTP status code",
+                    endpoint_path,
+                    err.response.status_code,
+                )
+            else:
+                logger.error(
+                    "Unable to get a response from indexd `POST %s` endpoint",
+                    endpoint_path,
+                )
+
+    if type(metadata_objects) is dict:
+        response = {
+            guid: {"record": records[guid] if guid in records else {}, "metadata": o}
+            for guid, o in metadata_objects.items()
+        }
+    else:
+        response = metadata_objects
+    return response
+
+
 @mod.get("/objects/{guid:path}/download")
 async def get_object_signed_download_url(
     guid: str,