OpenWebUI/open-webui
1
0
Fork 0
mirror of https://github.com/open-webui/open-webui synced 2025-06-26 18:26:48 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

refac: openapi to tool spec

Browse Source
This commit is contained in:
Timothy Jaeryang Baek
2025-04-19 03:46:06 -07:00
parent 332f8579d7
commit 463d7fb628
2 changed files with 115 additions and 107 deletions
Download Patch File Download Diff File Expand all files Collapse all files

118
src/lib/utils/index.ts
View File

@@ -1243,60 +1243,62 @@ export const convertOpenApiToToolPayload = (openApiSpec) => {
for (const [path, methods] of Object.entries(openApiSpec.paths)) {
for (const [method, operation] of Object.entries(methods)) {
const tool = {
type: 'function',
name: operation.operationId,
description: operation.description || operation.summary || 'No description available.',
parameters: {
type: 'object',
properties: {},
required: []
}
};
// Extract path and query parameters
if (operation.parameters) {
operation.parameters.forEach((param) => {
let description = param.schema.description || param.description || '';
if (param.schema.enum && Array.isArray(param.schema.enum)) {
description += `. Possible values: ${param.schema.enum.join(', ')}`;
if (operation?.operationId) {
const tool = {
type: 'function',
name: operation.operationId,
description: operation.description || operation.summary || 'No description available.',
parameters: {
type: 'object',
properties: {},
required: []
}
tool.parameters.properties[param.name] = {
type: param.schema.type,
description: description
};
};
if (param.required) {
tool.parameters.required.push(param.name);
}
});
}
// Extract and recursively resolve requestBody if available
if (operation.requestBody) {
const content = operation.requestBody.content;
if (content && content['application/json']) {
const requestSchema = content['application/json'].schema;
const resolvedRequestSchema = resolveSchema(requestSchema, openApiSpec.components);
if (resolvedRequestSchema.properties) {
tool.parameters.properties = {
...tool.parameters.properties,
...resolvedRequestSchema.properties
// Extract path and query parameters
if (operation.parameters) {
operation.parameters.forEach((param) => {
let description = param.schema.description || param.description || '';
if (param.schema.enum && Array.isArray(param.schema.enum)) {
description += `. Possible values: ${param.schema.enum.join(', ')}`;
}
tool.parameters.properties[param.name] = {
type: param.schema.type,
description: description
};
if (resolvedRequestSchema.required) {
tool.parameters.required = [
...new Set([...tool.parameters.required, ...resolvedRequestSchema.required])
];
if (param.required) {
tool.parameters.required.push(param.name);
}
});
}
// Extract and recursively resolve requestBody if available
if (operation.requestBody) {
const content = operation.requestBody.content;
if (content && content['application/json']) {
const requestSchema = content['application/json'].schema;
const resolvedRequestSchema = resolveSchema(requestSchema, openApiSpec.components);
if (resolvedRequestSchema.properties) {
tool.parameters.properties = {
...tool.parameters.properties,
...resolvedRequestSchema.properties
};
if (resolvedRequestSchema.required) {
tool.parameters.required = [
...new Set([...tool.parameters.required, ...resolvedRequestSchema.required])
];
}
} else if (resolvedRequestSchema.type === 'array') {
tool.parameters = resolvedRequestSchema; // special case when root schema is an array
}
} else if (resolvedRequestSchema.type === 'array') {
tool.parameters = resolvedRequestSchema; // special case when root schema is an array
}
}
}
toolPayload.push(tool);
toolPayload.push(tool);
}
}
}
@@ -1304,15 +1306,17 @@ export const convertOpenApiToToolPayload = (openApiSpec) => {
};
export const slugify = (str: string): string => {
return str
// 1. Normalize: separate accented letters into base + combining marks
.normalize("NFD")
// 2. Remove all combining marks (the accents)
.replace(/[\u0300-\u036f]/g, "")
// 3. Replace any sequence of whitespace with a single hyphen
.replace(/\s+/g, "-")
// 4. Remove all characters except alphanumeric characters and hyphens
.replace(/[^a-zA-Z0-9-]/g, "")
// 5. Convert to lowercase
.toLowerCase();
return (
str
// 1. Normalize: separate accented letters into base + combining marks
.normalize('NFD')
// 2. Remove all combining marks (the accents)
.replace(/[\u0300-\u036f]/g, '')
// 3. Replace any sequence of whitespace with a single hyphen
.replace(/\s+/g, '-')
// 4. Remove all characters except alphanumeric characters and hyphens
.replace(/[^a-zA-Z0-9-]/g, '')
// 5. Convert to lowercase
.toLowerCase()
);
};