Warning

This document is for an in-development version of Galaxy. You can alternatively view this page in the latest release if it exists or view the top of the latest release's documentation.

galaxy.webapps.openapi package

Submodules

galaxy.webapps.openapi.utils module

Allows merging overlapping openapi definitions. Taken from https://github.com/tiangolo/fastapi/pull/4727

galaxy.webapps.openapi.utils.get_openapi_security_definitions(flat_dependant: Dependant) → Tuple[Dict[str, Any], List[Dict[str, Any]]]

galaxy.webapps.openapi.utils.get_openapi_operation_parameters(*, all_route_params: Sequence[ModelField], model_name_map: Dict[Type[BaseModel] | Type[Enum], str]) → List[Dict[str, Any]]

galaxy.webapps.openapi.utils.get_openapi_operation_request_body(*, body_field: ModelField | None, model_name_map: Dict[Type[BaseModel] | Type[Enum], str]) → Dict[str, Any] | None

galaxy.webapps.openapi.utils.generate_operation_id(*, route: APIRoute, method: str) → str

galaxy.webapps.openapi.utils.generate_operation_summary(*, route: APIRoute, method: str) → str

galaxy.webapps.openapi.utils.get_openapi_operation_metadata(*, route: APIRoute, method: str, operation_ids: Set[str]) → Dict[str, Any]

galaxy.webapps.openapi.utils.get_openapi_path(*, route: APIRoute, model_name_map: Dict[type, str], operation_ids: Set[str]) → Tuple[Dict[str, Any], Dict[str, Any], Dict[str, Any]]

galaxy.webapps.openapi.utils.get_flat_models_from_routes(routes: Sequence[BaseRoute]) → Set[Type[BaseModel] | Type[Enum]]

galaxy.webapps.openapi.utils.get_openapi(*, title: str, version: str, openapi_version: str = '3.0.3', description: str | None = None, routes: Sequence[BaseRoute], tags: List[Dict[str, Any]] | None = None, servers: List[Dict[str, Any | str]] | None = None, terms_of_service: str | None = None, contact: Dict[str, Any | str] | None = None, license_info: Dict[str, Any | str] | None = None) → Dict[str, Any]

galaxy.webapps.openapi.utils.merge_paths(existing_path: Dict[str, Any], new_path: Dict[str, Any]) → Dict[str, Any]

Merge two openapi path descriptions for the same route, e.g. for response content with different accept-encoding.

galaxy.webapps.openapi.utils.merge_tags(tags_by_id: Dict[str, List[str] | None]) → List[str] | None

galaxy.webapps.openapi.utils.merge_summary(summary_by_id: Dict[str, str | None]) → str | None

galaxy.webapps.openapi.utils.merge_description(desc_by_id: Dict[str, str | None]) → str | None

galaxy.webapps.openapi.utils.merge_operation_id(operation_id_by_id: Dict[str, str | None]) → str | None

galaxy.webapps.openapi.utils.merge_deprecated(deprecated_by_id: Dict[str, bool | None]) → bool | None

galaxy.webapps.openapi.utils.merge_parameters(params_by_id: Dict[str, List[Dict[str, Any]] | None]) → List[Dict[str, Any]] | None

galaxy.webapps.openapi.utils.deep_dict_operation_merge(dict_by_id: Dict[str, Dict[str, Any]]) → Dict[str, Any]