@galaxy-tool-util/tool-cache-proxy 1.10.1 → 1.12.0

package/dist/generated/api-types.d.ts

@@ -0,0 +1,761 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+export interface paths {
+    "/api/tools": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Search cached tools
+         * @description Substring search across cached tools (q matches tool_id / name / description). Pagination via page (1-based) and page_size (default 25, max 200).
+         */
+        get: operations["searchTools"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/ga4gh/trs/v2/tools": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * List TRS tools
+         * @description GA4GH TRS v2 — list all cached tools as TRS Tool objects.
+         */
+        get: operations["trsListTools"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/ga4gh/trs/v2/tools/{tool_id}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** Get a TRS tool */
+        get: operations["trsGetTool"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/ga4gh/trs/v2/tools/{tool_id}/versions": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** List TRS tool versions */
+        get: operations["trsListVersions"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/tools/{tool_id}/versions/{tool_version}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get parsed tool
+         * @description Returns the cached ParsedTool (Galaxy meta-model).
+         */
+        get: operations["getParsedTool"];
+        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;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** Parameter request JSON Schema */
+        get: operations["getParameterRequestSchema"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/tools/{tool_id}/versions/{tool_version}/parameter_landing_request_schema": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** Parameter landing-request JSON Schema */
+        get: operations["getParameterLandingRequestSchema"];
+        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;
+        };
+        /** Parameter test-case-XML JSON Schema */
+        get: operations["getParameterTestCaseXmlSchema"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/tools/{tool_id}/versions/{tool_version}/tool_source": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Serialized tool wrapper source
+         * @description Lazily fetch and cache the serialized wrapper selected by tool version. XML macros are expanded by the upstream provider. Exact repository changesets and original macro files are not selected by this endpoint. Refetch or delete the cache entry to invalidate its source.
+         */
+        get: operations["getToolSource"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/tool-cache": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** List cached tools (admin) */
+        get: operations["listCache"];
+        put?: never;
+        post?: never;
+        /** Clear cache (optionally by prefix) */
+        delete: operations["clearCache"];
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/tool-cache/stats": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** Aggregate cache stats */
+        get: operations["cacheStats"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/tool-cache/{cacheKey}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post?: never;
+        /** Delete a single cache entry */
+        delete: operations["deleteCacheEntry"];
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/tool-cache/refetch": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /** Force-refetch a tool */
+        post: operations["refetchTool"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/tool-cache/add": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /** Populate the cache for a known tool id (idempotent) */
+        post: operations["addTool"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+}
+export type webhooks = Record<string, never>;
+export interface components {
+    schemas: {
+        ErrorBody: {
+            detail: string;
+        };
+        /** @description Galaxy parsed tool meta-model. Fully described in @galaxy-tool-util/schema; surfaced opaquely here. */
+        ParsedTool: {
+            [key: string]: unknown;
+        };
+        TrsToolClass: {
+            id?: string;
+            name?: string;
+            description?: string;
+        };
+        TrsToolVersion: {
+            url: string;
+            id: string;
+            name?: string;
+            is_production?: boolean;
+            descriptor_type?: ("CWL" | "WDL" | "NFL" | "GALAXY" | "SMK")[];
+            containerfile?: boolean;
+            meta_version?: string;
+            verified?: boolean;
+            signed?: boolean;
+        };
+        TrsTool: {
+            url: string;
+            id: string;
+            organization: string;
+            toolclass: components["schemas"]["TrsToolClass"];
+            versions: components["schemas"]["TrsToolVersion"][];
+            name?: string;
+            description?: string;
+            meta_version?: string;
+            has_checker?: boolean;
+            checker_url?: string;
+        };
+        SearchHit: {
+            toolId: string;
+            toolVersion: string;
+            name?: string;
+            description?: string;
+        };
+        SearchResults: {
+            q: string;
+            page: number;
+            pageSize: number;
+            total: number;
+            hits: components["schemas"]["SearchHit"][];
+        };
+        CachedToolEntry: {
+            cacheKey: string;
+            toolId: string;
+            toolVersion: string;
+            /** @description Cache request version when it differs from the displayed wrapper version, such as _default_. */
+            requestVersion?: string;
+            source: string;
+            sourceUrl: string;
+            cachedAt: string;
+            sizeBytes?: number;
+            decodable: boolean;
+            toolshedUrl?: string;
+            refetchable: boolean;
+        };
+        CacheStats: {
+            count: number;
+            totalBytes?: number;
+            bySource: {
+                [key: string]: number;
+            };
+            oldest?: string;
+            newest?: string;
+        };
+        ListResponse: {
+            entries: components["schemas"]["CachedToolEntry"][];
+            stats: components["schemas"]["CacheStats"];
+        };
+        DeleteResponse: {
+            removed: boolean;
+        };
+        ClearResponse: {
+            removed: number;
+        };
+        RefetchRequest: {
+            toolId: string;
+            toolVersion?: string;
+        };
+        RefetchResponse: {
+            cacheKey: string;
+            fetched: boolean;
+            alreadyCached: boolean;
+        };
+        AddRequest: {
+            toolId: string;
+            toolVersion?: string;
+        };
+        AddResponse: {
+            cacheKey: string;
+            alreadyCached: boolean;
+        };
+    };
+    responses: {
+        /** @description Not found */
+        NotFound: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/json": components["schemas"]["ErrorBody"];
+            };
+        };
+        /** @description Error */
+        Error: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/json": components["schemas"]["ErrorBody"];
+            };
+        };
+        /** @description JSON Schema document */
+        JsonSchemaResponse: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/json": {
+                    [key: string]: unknown;
+                };
+            };
+        };
+    };
+    parameters: {
+        /** @description TRS-form tool id (owner~repo~tool_id). */
+        ToolId: string;
+        ToolVersion: string;
+    };
+    requestBodies: never;
+    headers: never;
+    pathItems: never;
+}
+export type $defs = Record<string, never>;
+export interface operations {
+    searchTools: {
+        parameters: {
+            query?: {
+                q?: string;
+                page?: number;
+                page_size?: number;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Search results */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["SearchResults"];
+                };
+            };
+        };
+    };
+    trsListTools: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Tool list */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["TrsTool"][];
+                };
+            };
+        };
+    };
+    trsGetTool: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description TRS-form tool id (owner~repo~tool_id). */
+                tool_id: components["parameters"]["ToolId"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Tool */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["TrsTool"];
+                };
+            };
+            404: components["responses"]["NotFound"];
+        };
+    };
+    trsListVersions: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description TRS-form tool id (owner~repo~tool_id). */
+                tool_id: components["parameters"]["ToolId"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Tool versions */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["TrsToolVersion"][];
+                };
+            };
+            404: components["responses"]["NotFound"];
+        };
+    };
+    getParsedTool: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description TRS-form tool id (owner~repo~tool_id). */
+                tool_id: components["parameters"]["ToolId"];
+                tool_version: components["parameters"]["ToolVersion"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Parsed tool */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ParsedTool"];
+                };
+            };
+            404: components["responses"]["NotFound"];
+        };
+    };
+    getParameterRequestSchema: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description TRS-form tool id (owner~repo~tool_id). */
+                tool_id: components["parameters"]["ToolId"];
+                tool_version: components["parameters"]["ToolVersion"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: components["responses"]["JsonSchemaResponse"];
+            404: components["responses"]["NotFound"];
+        };
+    };
+    getParameterLandingRequestSchema: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description TRS-form tool id (owner~repo~tool_id). */
+                tool_id: components["parameters"]["ToolId"];
+                tool_version: components["parameters"]["ToolVersion"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: components["responses"]["JsonSchemaResponse"];
+            404: components["responses"]["NotFound"];
+        };
+    };
+    getParameterTestCaseXmlSchema: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description TRS-form tool id (owner~repo~tool_id). */
+                tool_id: components["parameters"]["ToolId"];
+                tool_version: components["parameters"]["ToolVersion"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: components["responses"]["JsonSchemaResponse"];
+            404: components["responses"]["NotFound"];
+        };
+    };
+    getToolSource: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description TRS-form tool id (owner~repo~tool_id). */
+                tool_id: components["parameters"]["ToolId"];
+                tool_version: components["parameters"]["ToolVersion"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Wrapper text, without JSON encoding. */
+            200: {
+                headers: {
+                    /** @description Wrapper format reported by the provider, or text if unknown. */
+                    language?: "xml" | "yaml" | "json" | "cwl" | "text";
+                    /** @description true for expanded XML; false for formats without XML macros. */
+                    "X-Tool-Source-Macros-Expanded"?: "true" | "false";
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** @description Tool source not found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        detail?: string;
+                    };
+                };
+            };
+            /** @description Upstream source fetch failed */
+            502: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        detail?: string;
+                    };
+                };
+            };
+        };
+    };
+    listCache: {
+        parameters: {
+            query?: {
+                /** @description When 1, probe each entry to flag undecodable payloads. */
+                decode?: "1";
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Listing + stats */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ListResponse"];
+                };
+            };
+        };
+    };
+    clearCache: {
+        parameters: {
+            query?: {
+                prefix?: string;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Clear result */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ClearResponse"];
+                };
+            };
+        };
+    };
+    cacheStats: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Stats */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["CacheStats"];
+                };
+            };
+        };
+    };
+    deleteCacheEntry: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                cacheKey: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Removed */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["DeleteResponse"];
+                };
+            };
+            404: components["responses"]["NotFound"];
+        };
+    };
+    refetchTool: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["RefetchRequest"];
+            };
+        };
+        responses: {
+            /** @description Refetch result */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["RefetchResponse"];
+                };
+            };
+            400: components["responses"]["Error"];
+            502: components["responses"]["Error"];
+        };
+    };
+    addTool: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["AddRequest"];
+            };
+        };
+        responses: {
+            /** @description Add result */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AddResponse"];
+                };
+            };
+            400: components["responses"]["Error"];
+            502: components["responses"]["Error"];
+        };
+    };
+}
+//# sourceMappingURL=api-types.d.ts.map