From f701de881773ff58d62727844f2012898795f73a Mon Sep 17 00:00:00 2001 From: John Chilton Date: Mon, 22 Sep 2025 11:29:20 -0400 Subject: [PATCH] Update tool state docs for relaxed requests. --- doc/source/dev/tool_state_api.plantuml.svg | 16 +++--- doc/source/dev/tool_state_api.plantuml.txt | 7 ++- .../dev/tool_state_state_classes.plantuml.svg | 56 ++++++++++++++----- .../dev/tool_state_state_classes.plantuml.txt | 2 +- 4 files changed, 56 insertions(+), 25 deletions(-) diff --git a/doc/source/dev/tool_state_api.plantuml.svg b/doc/source/dev/tool_state_api.plantuml.svg index 3aaf86c1ee0..1a6f3cc5773 100644 --- a/doc/source/dev/tool_state_api.plantuml.svg +++ b/doc/source/dev/tool_state_api.plantuml.svg @@ -1,4 +1,4 @@ -API RequestAPI RequestJobs APIJobs APIJob ServiceJob ServiceDatabaseDatabaseTaskQueueTaskQueueHTTP JSONTo boundaryBuild RequestToolStateValidate RequestToolState (pydantic)decode() RequestToolStateinto RequestInternalToolStateSerialize RequestInternalToolStateQueue QueueJobs with reference topersisted RequestInternalToolStateJobCreateResponse(pydantic model)JobCreateResponse(as json)galaxy.tool_util.parameters.stateToolStatestate_representation: strinput_state: Dict[str, Any]validate(parameters: ToolParameterBundle)_to_base_model(parameters: ToolParameterBundle): Optional[Type[BaseModel]]RequestToolStatestate_representation = "request"_to_base_model(parameters: ToolParameterBundle): Type[BaseModel]Object references of the form{src: "hda", id: <encoded_id>}.Allow mapping/reduce constructs.RequestInternalToolStatestate_representation = "request_internal"_to_base_model(parameters: ToolParameterBundle): Type[BaseModel]Object references of the form{src: "hda", id: <decoded_id>}.Allow mapping/reduce constructs. Allows URI src dicts.RequestInternalDereferencedToolStatestate_representation = "request_internal"_to_base_model(parameters: ToolParameterBundle): Type[BaseModel]Object references of the form{src: "hda", id: <decoded_id>}.Allow mapping/reduce constructs. No URI src dicts - all converted to HDAs.JobInternalToolStatestate_representation = "job_internal"_to_base_model(parameters: ToolParameterBundle): Type[BaseModel]Object references of the form{src: "hda", id: <decoded_id>}.Mapping constructs expanded out.(Defaults are inserted?)decodedereferenceexpandgalaxy.tool_util.parameters.stateToolStatestate_representation: strinput_state: Dict[str, Any]validate(parameters: ToolParameterBundle)_to_base_model(parameters: ToolParameterBundle): Optional[Type[BaseModel]]RelaxedRequestToolStatestate_representation = "request"_to_base_model(parameters: ToolParameterBundle): Type[BaseModel]Object references of the form{src: "hda", id: <encoded_id>}.Allow mapping/reduce constructs. Relaxed syntax to allow some of the oddstuff allowed in legacy tool input format.RequestToolStatestate_representation = "request"_to_base_model(parameters: ToolParameterBundle): Type[BaseModel]Object references of the form{src: "hda", id: <encoded_id>}.Allow mapping/reduce constructs.RequestInternalToolStatestate_representation = "request_internal"_to_base_model(parameters: ToolParameterBundle): Type[BaseModel]Object references of the form{src: "hda", id: <decoded_id>}.Allow mapping/reduce constructs. Allows URI src dicts.RequestInternalDereferencedToolStatestate_representation = "request_internal"_to_base_model(parameters: ToolParameterBundle): Type[BaseModel]Object references of the form{src: "hda", id: <decoded_id>}.Allow mapping/reduce constructs. No URI src dicts - all converted to HDAs.JobInternalToolStatestate_representation = "job_internal"_to_base_model(parameters: ToolParameterBundle): Type[BaseModel]Object references of the form{src: "hda", id: <decoded_id>}.Mapping constructs expanded out.(Defaults are inserted?)TestCaseToolStatestate_representation = "test_case"_to_base_model(input_models: ToolParameterBundle): Type[BaseModel]Object references of the form file name and URIs.Mapping constructs not allowed. WorkflowStepToolStatestate_representation = "workflow_step"_to_base_model(input_models: ToolParameterBundle): Type[BaseModel]Nearly everything optional except conditional discriminators. WorkflowStepLinkedToolStatestate_representation = "workflow_step_linked"_to_base_model(input_models: ToolParameterBundle): Type[BaseModel]Expect pre-process ``in`` dictionaries and bring in representationof links and defaults and validate them in model. strictifydecodedereferenceexpandpreprocess_links_and_defaults