API server: Allow filtering in paginated methods

[bisgaard-itis]

Is there an existing issue for this?

• I have searched the existing issues

User Story

If I have submitted 10**6 jobs to my solver I face performance issues when listing the jobs on the client side (even after introduction of the paginated methods). Hence, it would be nice to allow for filtering.

• Include search

Definition of Done

Support filtering in some/all paginated endpoints of the API server

[pcrespov]

• i would very much like to have the filter/sort/pagination options/design analogous across all collections in the api-server
• A good reference of how to design this I learned in docker api
• We started (matus and me) building it into the projects but it is half done. SEE

  osparc-simcore/services/web/server/src/simcore_service_webserver/projects/_crud_handlers_models.py

  Lines 17 to 36 in e1c7636

  	class ProjectCreateParams(BaseModel):
  	from_study: ProjectID | None = Field(
  	None,
  	description="Option to create a project from existing template or study: from_study={study_uuid}",
  	)
  	as_template: bool = Field(
  	default=False,
  	description="Option to create a template from existing project: as_template=true",
  	)
  	copy_data: bool = Field(
  	default=True,
  	description="Option to copy data when creating from an existing template or as a template, defaults to True",
  	)
  	hidden: bool = Field(
  	default=False,
  	description="Enables/disables hidden flag. Hidden projects are by default unlisted",
  	)
  	class Config:
  	extra = Extra.forbid

• SEE also docker API https://docs.docker.com/engine/api/v1.43/#tag/Container/operation/ContainerList
• specifically look at the filters query parameter. They are "topic-based" filters