[ENH] project info (#683)

* change to project_info branch

* add info to project endpoint

* update openapi

* style fix

Author: jdkent

compose/neurosynth_compose/openapi

@@ -224,9 +224,7 @@ def get(self, id):
         record = self._model.query.filter_by(id=id).first_or_404()
         args = parser.parse(self._user_args, request, location="query")
 
-        return self.__class__._schema(context={"nested": args.get("nested")}).dump(
-            record
-        )
+        return self.__class__._schema(context=args).dump(record)
 
     def put(self, id):
         id = id.replace("\x00", "\uFFFD")
@@ -279,6 +277,7 @@ def insert_data(self, id, data):
     "dataset_id": fields.String(missing=None),
     "export": fields.Boolean(missing=False),
     "data_type": fields.String(missing=None),
+    "info": fields.Boolean(missing=False),
 }
 
 
@@ -352,10 +351,10 @@ def search(self):
         records = q.paginate(
             page=args["page"], per_page=args["page_size"], error_out=False
         ).items
-        # check if results should be nested
-        nested = True if args.get("nested") else False
         content = self.__class__._schema(
-            only=self._only, many=True, context={"nested": nested}
+            only=self._only,
+            many=True,
+            context=args,
         ).dump(records)
         response = {
             "metadata": {},

compose/neurosynth_compose/resources/analysis.py

@@ -67,8 +67,21 @@ def _serialize(self, value, attr, obj, **kwargs):
             if self.metadata.get("nested", None) is False
             else self.context.get("nested")
         )
+        info = self.context.get("info")
+        if info:
+            schema = self.schema
+            info_fields = [
+                field
+                for field, f_obj in schema._declared_fields.items()
+                if f_obj.metadata.get("info_field")
+            ]
+            schema.only = schema.set_class(info_fields)
+            # set exclude to an empty set
+            schema.exclude = schema.set_class()
+            schema._init_fields()
+
         nested_attr = self.metadata.get("pluck")
-        if nested:
+        if nested or info:
             many = self.schema.many or self.many
             nested_obj = getattr(obj, self.data_key or self.name)
             return self.schema.dump(nested_obj, many=many)
@@ -115,11 +128,13 @@ def _deserialize(self, value, attr, data, **kwargs):
 
 
 class BaseSchema(Schema):
-    id = PGSQLString()
+    id = PGSQLString(metadata={"info_field": True})
     created_at = fields.DateTime()
     updated_at = fields.DateTime(allow_none=True)
     user_id = fields.String(data_key="user")
-    username = fields.String(attribute="user.name", dump_only=True)
+    username = fields.String(
+        attribute="user.name", dump_only=True, metadata={"info_field": True}
+    )
 
 
 class ConditionSchema(Schema):
@@ -284,8 +299,8 @@ def process_data(self, data, **kwargs):
 
 
 class MetaAnalysisSchema(BaseSchema):
-    name = fields.String(allow_none=True)
-    description = fields.String(allow_none=True)
+    name = fields.String(allow_none=True, metadata={"info_field": True})
+    description = fields.String(allow_none=True, metadata={"info_field": True})
     provenance = fields.Dict(allow_none=True)
     specification_id = StringOrNested(SpecificationSchema, data_key="specification")
     neurostore_analysis = fields.Nested("NeurostoreAnalysisSchema", dump_only=True)
@@ -324,6 +339,8 @@ class MetaAnalysisSchema(BaseSchema):
 
     @post_dump
     def create_neurostore_url(self, data, **kwargs):
+        if self.context.get("info"):
+            return data
         if data.get("neurostore_analysis", None) and data["neurostore_analysis"].get(
             "neurostore_id", None
         ):

compose/neurosynth_compose/schemas/analysis.py

@@ -0,0 +1,20 @@
+from neurosynth_compose.models import Project
+from neurosynth_compose.schemas import MetaAnalysisSchema
+
+
+def test_project_info(session, app, auth_client, user_data):
+    proj = Project.query.first()
+
+    info_resp = auth_client.get(f"/api/projects/{proj.id}?info=true")
+    assert info_resp.status_code == 200
+
+    info_fields = [
+        f
+        for f, v in MetaAnalysisSchema._declared_fields.items()
+        if v.metadata.get("info_field")
+    ]
+
+    meta_analysis = info_resp.json["meta_analyses"][0]
+
+    for f in info_fields:
+        assert f in meta_analysis