Skip to content

Commit

Permalink
Update API schema for more tool state schema APIs...
Browse files Browse the repository at this point in the history
  • Loading branch information
@jmchilton
jmchilton committed Dec 3, 2024
1 parent 8d7ff7c commit 2c06842
Show file tree
Hide file tree
Showing 2 changed files with 314 additions and 2 deletions.
192 changes: 192 additions & 0 deletions client/src/api/schema/schema.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4569,6 +4569,60 @@ export interface paths {
patch?: never;
trace?: never;
};
"/api/tools/{tool_id}/parameter_landing_request_schema": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Return a JSON schema description of the tool's inputs for the tool landing request API. */
get: operations["tools__parameter_landing_request_schema"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/tools/{tool_id}/parameter_request_schema": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Return a JSON schema description of the tool's inputs for the tool request API that will be added to Galaxy at some point
* @description The tool request schema includes validation of map/reduce concepts that can be consumed by the tool execution API and not just the request for a single execution.
*/
get: operations["tools__parameter_request_schema"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/tools/{tool_id}/parameter_test_case_xml_schema": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Return a JSON schema description of the tool's inputs for test case construction. */
get: operations["tools__parameter_test_case_xml_schema"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/tours": {
parameters: {
query?: never;
Expand Down Expand Up @@ -34727,6 +34781,144 @@ export interface operations {
};
};
};
tools__parameter_landing_request_schema: {
parameters: {
query?: {
tool_version?: string | null;
};
header?: {
/** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */
"run-as"?: string | null;
};
path: {
/** @description The tool ID for the lineage stored in Galaxy's toolbox. */
tool_id: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description Request Error */
"4XX": {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["MessageExceptionModel"];
};
};
/** @description Server Error */
"5XX": {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["MessageExceptionModel"];
};
};
};
};
tools__parameter_request_schema: {
parameters: {
query?: {
tool_version?: string | null;
};
header?: {
/** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */
"run-as"?: string | null;
};
path: {
/** @description The tool ID for the lineage stored in Galaxy's toolbox. */
tool_id: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description Request Error */
"4XX": {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["MessageExceptionModel"];
};
};
/** @description Server Error */
"5XX": {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["MessageExceptionModel"];
};
};
};
};
tools__parameter_test_case_xml_schema: {
parameters: {
query?: {
tool_version?: string | null;
};
header?: {
/** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */
"run-as"?: string | null;
};
path: {
/** @description The tool ID for the lineage stored in Galaxy's toolbox. */
tool_id: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description Request Error */
"4XX": {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["MessageExceptionModel"];
};
};
/** @description Server Error */
"5XX": {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["MessageExceptionModel"];
};
};
};
};
index_api_tours_get: {
parameters: {
query?: never;
Expand Down
124 changes: 122 additions & 2 deletions lib/tool_shed/webapp/frontend/src/schema/schema.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -532,6 +532,23 @@ export interface paths {
patch?: never
trace?: never
}
"/api/tools/{tool_id}/versions/{tool_version}/parameter_landing_request_schema": {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
/** Return a JSON schema description of the tool's inputs for the tool landing request API. */
get: operations["tools__parameter_landing_request_schema"]
put?: never
post?: never
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
"/api/tools/{tool_id}/versions/{tool_version}/parameter_request_schema": {
parameters: {
query?: never
Expand All @@ -543,7 +560,24 @@ export interface paths {
* Return a JSON schema description of the tool's inputs for the tool request API that will be added to Galaxy at some point
* @description The tool request schema includes validation of map/reduce concepts that can be consumed by the tool execution API and not just the request for a single execution.
*/
get: operations["tools__parameter_request_model"]
get: operations["tools__parameter_request_schema"]
put?: never
post?: never
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
"/api/tools/{tool_id}/versions/{tool_version}/parameter_test_case_xml_schema": {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
/** Return a JSON schema description of the tool's inputs for test case construction. */
get: operations["tools__parameter_test_case_xml_schema"]
put?: never
post?: never
delete?: never
Expand Down Expand Up @@ -4422,7 +4456,93 @@ export interface operations {
}
}
}
tools__parameter_request_model: {
tools__parameter_landing_request_schema: {
parameters: {
query?: never
header?: never
path: {
/** @description See also https://ga4gh.github.io/tool-registry-service-schemas/DataModel/#trs-tool-and-trs-tool-version-ids */
tool_id: string
/** @description The full version string defined on the Galaxy tool wrapper. */
tool_version: string
}
cookie?: never
}
requestBody?: never
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown
}
content: {
"application/json": unknown
}
}
/** @description Request Error */
"4XX": {
headers: {
[name: string]: unknown
}
content: {
"application/json": components["schemas"]["MessageExceptionModel"]
}
}
/** @description Server Error */
"5XX": {
headers: {
[name: string]: unknown
}
content: {
"application/json": components["schemas"]["MessageExceptionModel"]
}
}
}
}
tools__parameter_request_schema: {
parameters: {
query?: never
header?: never
path: {
/** @description See also https://ga4gh.github.io/tool-registry-service-schemas/DataModel/#trs-tool-and-trs-tool-version-ids */
tool_id: string
/** @description The full version string defined on the Galaxy tool wrapper. */
tool_version: string
}
cookie?: never
}
requestBody?: never
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown
}
content: {
"application/json": unknown
}
}
/** @description Request Error */
"4XX": {
headers: {
[name: string]: unknown
}
content: {
"application/json": components["schemas"]["MessageExceptionModel"]
}
}
/** @description Server Error */
"5XX": {
headers: {
[name: string]: unknown
}
content: {
"application/json": components["schemas"]["MessageExceptionModel"]
}
}
}
}
tools__parameter_test_case_xml_schema: {
parameters: {
query?: never
header?: never
Expand Down

0 comments on commit 2c06842

Please sign in to comment.