Skip to content

Commit

Permalink
Update description of '/api/jobs/{job_id}/parameters_display'
Browse files Browse the repository at this point in the history
  • Loading branch information
mvdbeek committed Nov 21, 2023
1 parent c0d43cf commit f18a33b
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 37 deletions.
28 changes: 4 additions & 24 deletions client/src/api/schema/schema.ts
Original file line number Diff line number Diff line change
Expand Up @@ -178,12 +178,7 @@ export interface paths {
/**
* Resolve parameters as a list for nested display.
* @deprecated
* @description Resolve parameters as a list for nested display. More client logic
* here than is ideal but it is hard to reason about tool parameter
* types on the client relative to the server. Job accessibility checks
* are slightly different than dataset checks, so both methods are
* available.
*
* @description Resolve parameters as a list for nested display.
* This API endpoint is unstable and tied heavily to Galaxy's JS client code,
* this endpoint will change frequently.
*/
Expand Down Expand Up @@ -964,12 +959,7 @@ export interface paths {
"/api/jobs/{job_id}/parameters_display": {
/**
* Resolve parameters as a list for nested display.
* @description Resolve parameters as a list for nested display. More client logic
* here than is ideal but it is hard to reason about tool parameter
* types on the client relative to the server. Job accessibility checks
* are slightly different than dataset checks, so both methods are
* available.
*
* @description Resolve parameters as a list for nested display.
* This API endpoint is unstable and tied heavily to Galaxy's JS client code,
* this endpoint will change frequently.
*/
Expand Down Expand Up @@ -11055,12 +11045,7 @@ export interface operations {
/**
* Resolve parameters as a list for nested display.
* @deprecated
* @description Resolve parameters as a list for nested display. More client logic
* here than is ideal but it is hard to reason about tool parameter
* types on the client relative to the server. Job accessibility checks
* are slightly different than dataset checks, so both methods are
* available.
*
* @description Resolve parameters as a list for nested display.
* This API endpoint is unstable and tied heavily to Galaxy's JS client code,
* this endpoint will change frequently.
*/
Expand Down Expand Up @@ -15533,12 +15518,7 @@ export interface operations {
resolve_parameters_display_api_jobs__job_id__parameters_display_get: {
/**
* Resolve parameters as a list for nested display.
* @description Resolve parameters as a list for nested display. More client logic
* here than is ideal but it is hard to reason about tool parameter
* types on the client relative to the server. Job accessibility checks
* are slightly different than dataset checks, so both methods are
* available.
*
* @description Resolve parameters as a list for nested display.
* This API endpoint is unstable and tied heavily to Galaxy's JS client code,
* this endpoint will change frequently.
*/
Expand Down
2 changes: 2 additions & 0 deletions lib/galaxy/managers/jobs.py
Original file line number Diff line number Diff line change
Expand Up @@ -880,6 +880,8 @@ def summarize_job_parameters(trans, job):
Precondition: the caller has verified the job is accessible to the user
represented by the trans parameter.
"""
# More client logic here than is ideal but it is hard to reason about
# tool parameter types on the client relative to the server.

def inputs_recursive(input_params, param_values, depth=1, upgrade_messages=None):
if upgrade_messages is None:
Expand Down
4 changes: 3 additions & 1 deletion lib/galaxy/security/idencoding.py
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,11 @@ def __init__(self, **config):
per_kind_id_secret_base = config.get("per_kind_id_secret_base", self.id_secret)
self.id_ciphers_for_kind = _cipher_cache(per_kind_id_secret_base)

def encode_id(self, obj_id, kind=None):
def encode_id(self, obj_id, kind=None, strict_integer=False):
if obj_id is None:
raise galaxy.exceptions.MalformedId("Attempted to encode None id")
if strict_integer and not isinstance(obj_id, int):
raise galaxy.exceptions.MalformedId("Attempted to encode id that is not an integer")
id_cipher = self.__id_cipher(kind)
# Convert to bytes
s = smart_str(obj_id)
Expand Down
14 changes: 2 additions & 12 deletions lib/galaxy/webapps/galaxy/api/jobs.py
Original file line number Diff line number Diff line change
Expand Up @@ -372,12 +372,7 @@ def parameters_display_by_job(
trans: ProvidesUserContext = DependsOnTrans,
) -> JobDisplayParametersSummary:
"""
Resolve parameters as a list for nested display. More client logic
here than is ideal but it is hard to reason about tool parameter
types on the client relative to the server. Job accessibility checks
are slightly different than dataset checks, so both methods are
available.
Resolve parameters as a list for nested display.
This API endpoint is unstable and tied heavily to Galaxy's JS client code,
this endpoint will change frequently.
"""
Expand All @@ -398,12 +393,7 @@ def parameters_display_by_dataset(
trans: ProvidesUserContext = DependsOnTrans,
) -> JobDisplayParametersSummary:
"""
Resolve parameters as a list for nested display. More client logic
here than is ideal but it is hard to reason about tool parameter
types on the client relative to the server. Job accessibility checks
are slightly different than dataset checks, so both methods are
available.
Resolve parameters as a list for nested display.
This API endpoint is unstable and tied heavily to Galaxy's JS client code,
this endpoint will change frequently.
"""
Expand Down

0 comments on commit f18a33b

Please sign in to comment.