forked from enviPath/enviPy
Tobias O
8adb93012a
## Major Changes - Implement a REST style API app in epapi - Currently implements a GET method for all entity types in the browse menu (both package level and global) - Provides paginated results per default with query style filtering for reviewed vs unreviewed. - Provides new paginated templates with thin wrappers per entity types for easier maintainability - Implements e2e tests for the API ## Minor changes - Added more comprehensive gitignore to cover coverage reports and other test/node.js etc. data. - Add additional CI file for API tests that only gets triggered on API relevant changes. ## ⚠️ Currently only works with session-based authentication. Token based will be added in new PR. Co-authored-by: Tim Lorsbach <tim@lorsba.ch> Co-authored-by: jebus <lorsbach@envipath.com> Reviewed-on: enviPath/enviPy#243 Co-authored-by: Tobias O <tobias.olenyi@envipath.com> Co-committed-by: Tobias O <tobias.olenyi@envipath.com>
105 lines
2.4 KiB
Python
105 lines
2.4 KiB
Python
from ninja import FilterSchema, FilterLookup, Schema
|
|
from typing import Annotated, Optional
|
|
from uuid import UUID
|
|
|
|
|
|
# Filter schema for query parameters
|
|
class ReviewStatusFilter(FilterSchema):
|
|
"""Filter schema for review_status query parameter."""
|
|
|
|
review_status: Annotated[Optional[bool], FilterLookup("package__reviewed")] = None
|
|
|
|
|
|
class SelfReviewStatusFilter(FilterSchema):
|
|
"""Filter schema for review_status query parameter on self-reviewed entities."""
|
|
|
|
review_status: Annotated[Optional[bool], FilterLookup("reviewed")] = None
|
|
|
|
|
|
class StructureReviewStatusFilter(FilterSchema):
|
|
"""Filter schema for review_status on structures (via compound->package)."""
|
|
|
|
review_status: Annotated[Optional[bool], FilterLookup("compound__package__reviewed")] = None
|
|
|
|
|
|
# Base schema for all package-scoped entities
|
|
class PackageEntityOutSchema(Schema):
|
|
"""Base schema for entities belonging to a package."""
|
|
|
|
uuid: UUID
|
|
url: str = ""
|
|
name: str
|
|
description: str
|
|
review_status: str = ""
|
|
package: str = ""
|
|
|
|
@staticmethod
|
|
def resolve_url(obj):
|
|
return obj.url
|
|
|
|
@staticmethod
|
|
def resolve_package(obj):
|
|
return obj.package.url
|
|
|
|
@staticmethod
|
|
def resolve_review_status(obj):
|
|
return "reviewed" if obj.package.reviewed else "unreviewed"
|
|
|
|
|
|
# All package-scoped entities inherit from base
|
|
class ScenarioOutSchema(PackageEntityOutSchema):
|
|
pass
|
|
|
|
|
|
class CompoundOutSchema(PackageEntityOutSchema):
|
|
pass
|
|
|
|
|
|
class RuleOutSchema(PackageEntityOutSchema):
|
|
pass
|
|
|
|
|
|
class ReactionOutSchema(PackageEntityOutSchema):
|
|
pass
|
|
|
|
|
|
class PathwayOutSchema(PackageEntityOutSchema):
|
|
pass
|
|
|
|
|
|
class ModelOutSchema(PackageEntityOutSchema):
|
|
pass
|
|
|
|
|
|
class CompoundStructureOutSchema(PackageEntityOutSchema):
|
|
compound: str = ""
|
|
|
|
@staticmethod
|
|
def resolve_compound(obj):
|
|
return obj.compound.url
|
|
|
|
@staticmethod
|
|
def resolve_package(obj):
|
|
return obj.compound.package.url
|
|
|
|
@staticmethod
|
|
def resolve_review_status(obj):
|
|
return "reviewed" if obj.compound.package.reviewed else "unreviewed"
|
|
|
|
|
|
# Package is special (no package FK)
|
|
class PackageOutSchema(Schema):
|
|
uuid: UUID
|
|
url: str = ""
|
|
name: str
|
|
description: str
|
|
review_status: str = ""
|
|
|
|
@staticmethod
|
|
def resolve_url(obj):
|
|
return obj.url
|
|
|
|
@staticmethod
|
|
def resolve_review_status(obj):
|
|
return "reviewed" if obj.reviewed else "unreviewed"
|