(PXP-5529): implement GET /objects endpoint

docs/openapi.yaml

@@ -412,6 +412,107 @@ paths:
       tags:
       - Index
   /objects:
+    get:
+      description: "Returns a list of objects and their corresponding Indexd records.\n\
+        \nGiven the following metadata objects:\n\n    {\n        \"0\": {\n     \
+        \       \"message\": \"hello\",\n            \"_uploader_id\": \"100\",\n\
+        \            \"_resource_paths\": [\n                \"/programs/a\",\n  \
+        \              \"/programs/b\"\n            ],\n            \"pet\": \"dog\"\
+        ,\n            \"pet_age\": 1\n        },\n        \"1\": {\n            \"\
+        message\": \"greetings\",\n            \"_uploader_id\": \"101\",\n      \
+        \      \"_resource_paths\": [\n                \"/open\",\n              \
+        \  \"/programs/c/projects/a\"\n            ],\n            \"pet\": \"ferret\"\
+        ,\n            \"pet_age\": 5,\n            \"sport\": \"soccer\"\n      \
+        \  },\n        \"2\": {\n            \"message\": \"morning\",\n         \
+        \   \"_uploader_id\": \"102\",\n            \"_resource_paths\": [\n     \
+        \           \"/programs/d\",\n                \"/programs/e\"\n          \
+        \  ],\n            \"counts\": [42, 42, 42],\n            \"pet\": \"ferret\"\
+        ,\n            \"pet_age\": 10,\n            \"sport\": \"soccer\"\n     \
+        \   },\n        \"3\": {\n            \"message\": \"evening\",\n        \
+        \    \"_uploader_id\": \"103\",\n            \"_resource_paths\": [\n    \
+        \            \"/programs/f/projects/a\",\n                \"/admin\"\n   \
+        \         ],\n            \"counts\": [1, 3, 5],\n            \"pet\": \"\
+        ferret\",\n            \"pet_age\": 15,\n            \"sport\": \"basketball\"\
+        \n        }\n    }\n\nExample requests with filters:\n\n    GET /objects?filter=(message,:eq,\"\
+        morning\") returns \"2\" (i.e. the MDS object and Indexd record identified\
+        \ by \"2\")\n    GET /objects?filter=(counts.1,:eq,3) returns \"3\"\n    GET\
+        \ /objects?filter=(pet_age,:lte,5) returns \"0\" and \"1\"\n    GET /objects?filter=(pet_age,:gt,5)\
+        \ returns \"2\" and \"3\"\n\nCompound expressions are supported:\n\n    GET\
+        \ /objects?filter=(_resource_paths,:any,(,:like,\"/programs/%/projects/%\"\
+        )) returns \"1\" and \"3\"\n    GET /objects?filter=(counts,:all,(,:eq,42))\
+        \ returns \"2\"\n\nBoolean expressions are also supported:\n\n    GET /objects?filter=(or,(_uploader_id,:eq,\"\
+        101\"),(_uploader_id,:eq,\"102\")) returns \"1\" and \"2\"\n    GET /objects?filter=(or,(and,(pet,:eq,\"\
+        ferret\"),(sport,:eq,\"soccer\")),(message,:eq,\"hello\")) returns \"0\",\
+        \ \"1\", and \"2\""
+      operationId: get_objects_objects_get
+      parameters:
+      - description: Switch to return a list of GUIDs (false), or metadata objects
+          (true).
+        in: query
+        name: data
+        required: false
+        schema:
+          default: true
+          description: Switch to return a list of GUIDs (false), or metadata objects
+            (true).
+          title: Data
+          type: boolean
+      - description: The offset for what objects are returned (zero-indexed). The
+          exact offset will be equal to page*limit (e.g. with page=1, limit=15, 15
+          objects beginning at index 15 will be returned).
+        in: query
+        name: page
+        required: false
+        schema:
+          default: 0
+          description: The offset for what objects are returned (zero-indexed). The
+            exact offset will be equal to page*limit (e.g. with page=1, limit=15,
+            15 objects beginning at index 15 will be returned).
+          title: Page
+          type: integer
+      - description: 'Maximum number of objects returned (max: 1024). Also used with
+          page to determine page size.'
+        in: query
+        name: limit
+        required: false
+        schema:
+          default: 10
+          description: 'Maximum number of objects returned (max: 1024). Also used
+            with page to determine page size.'
+          title: Limit
+          type: integer
+      - description: The filter(s) that will be applied to the result. The format
+          is filter=(field_name,operator,value), in which the field_name is a json
+          key without quotes, operator is one of :eq, :ne, :gt, :gte, :lt, :lte, :like,
+          :all, :any, and value is a typed json value against which the operator is
+          run (examples in the endpoint description).
+        in: query
+        name: filter
+        required: false
+        schema:
+          default: ''
+          description: The filter(s) that will be applied to the result. The format
+            is filter=(field_name,operator,value), in which the field_name is a json
+            key without quotes, operator is one of :eq, :ne, :gt, :gte, :lt, :lte,
+            :like, :all, :any, and value is a typed json value against which the operator
+            is run (examples in the endpoint description).
+          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\