Skip to content

fix(actions): Merge path-item parameters and flatten allOf in request bodies #12660

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
CarterPape wants to merge 1 commit into
base: main
Choose a base branch
from
+396 −5
Open

fix(actions): Merge path-item parameters and flatten allOf in request bodies #12660

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
287 changes: 287 additions & 0 deletions packages/data-provider/specs/actions.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1557,6 +1557,293 @@ describe('createURL', () => {
});
});

describe('openapiToFunction: path-item parameters and allOf request bodies', () => {
const baseSpec = {
openapi: '3.0.0' as const,
info: { title: 'Test', version: '1.0.0' },
servers: [{ url: 'https://api.example.com' }],
};

describe('path-item level parameters', () => {
it('merges shared path-item parameters into all operations', () => {
const spec: OpenAPIV3.Document = {
...baseSpec,
paths: {
'/items/{id}': {
parameters: [{ name: 'id', in: 'path', required: true, schema: { type: 'string' } }],
get: {
operationId: 'getItem',
responses: { '200': { description: 'ok' } },
},
delete: {
operationId: 'deleteItem',
responses: { '200': { description: 'ok' } },
},
},
},
};

const { functionSignatures } = openapiToFunction(spec);

const getItem = functionSignatures.find((s) => s.name === 'getItem');
const deleteItem = functionSignatures.find((s) => s.name === 'deleteItem');

expect(getItem).toBeDefined();
expect(deleteItem).toBeDefined();
expect(getItem?.parameters.properties).toHaveProperty('id');
expect(getItem?.parameters.required).toContain('id');
expect(deleteItem?.parameters.properties).toHaveProperty('id');
expect(deleteItem?.parameters.required).toContain('id');
});

it('does not create a ghost tool for the path-item parameters key', () => {
const spec: OpenAPIV3.Document = {
...baseSpec,
paths: {
'/items/{id}': {
parameters: [{ name: 'id', in: 'path', required: true, schema: { type: 'string' } }],
get: {
operationId: 'getItem',
responses: { '200': { description: 'ok' } },
},
},
},
};

const { functionSignatures } = openapiToFunction(spec);

const ghostTool = functionSignatures.find((s) => s.name.startsWith('parameters'));
expect(ghostTool).toBeUndefined();
expect(functionSignatures).toHaveLength(1);
});

it('operation-level parameter wins over path-item parameter on (name, in) collision', () => {
const spec: OpenAPIV3.Document = {
...baseSpec,
paths: {
'/items/{id}': {
parameters: [{ name: 'id', in: 'path', required: true, schema: { type: 'string' } }],
get: {
operationId: 'getItem',
// Operation-level overrides with integer type
parameters: [{ name: 'id', in: 'path', required: true, schema: { type: 'integer' } }],
responses: { '200': { description: 'ok' } },
},
delete: {
operationId: 'deleteItem',
responses: { '200': { description: 'ok' } },
},
},
},
};

const { functionSignatures } = openapiToFunction(spec);

const getItem = functionSignatures.find((s) => s.name === 'getItem');
const deleteItem = functionSignatures.find((s) => s.name === 'deleteItem');

// get uses operation-level integer
const getIdSchema = getItem?.parameters.properties['id'] as OpenAPIV3.SchemaObject;
expect(getIdSchema?.type).toBe('integer');

// delete still gets the path-item string
const deleteIdSchema = deleteItem?.parameters.properties['id'] as OpenAPIV3.SchemaObject;
expect(deleteIdSchema?.type).toBe('string');
});

it('ignores non-method keys on path items (summary, description, servers)', () => {
const spec: OpenAPIV3.Document = {
...baseSpec,
paths: {
'/items': {
summary: 'Item operations',
description: 'CRUD for items',
servers: [{ url: 'https://other.example.com' }],
get: {
operationId: 'listItems',
responses: { '200': { description: 'ok' } },
},
},
},
};

const { functionSignatures } = openapiToFunction(spec);

expect(functionSignatures).toHaveLength(1);
expect(functionSignatures[0].name).toBe('listItems');
});
});

describe('allOf in request bodies', () => {
it('flattens allOf in a request body into a single set of properties', () => {
const spec: OpenAPIV3.Document = {
...baseSpec,
paths: {
'/scrape': {
post: {
operationId: 'scrape',
requestBody: {
content: {
'application/json': {
schema: {
allOf: [
{
type: 'object',
properties: { url: { type: 'string' } },
required: ['url'],
},
{
type: 'object',
properties: {
formats: { type: 'array', items: { type: 'string' } },
onlyMainContent: { type: 'boolean' },
},
},
],
} as OpenAPIV3.SchemaObject,
},
},
},
responses: { '200': { description: 'ok' } },
},
},
},
};

const { functionSignatures } = openapiToFunction(spec);
const scrape = functionSignatures.find((s) => s.name === 'scrape');

expect(scrape).toBeDefined();
expect(scrape?.parameters.properties).toHaveProperty('url');
expect(scrape?.parameters.properties).toHaveProperty('formats');
expect(scrape?.parameters.properties).toHaveProperty('onlyMainContent');
expect(scrape?.parameters.required).toContain('url');
});

it('resolves $ref inside allOf members', () => {
const spec: OpenAPIV3.Document = {
...baseSpec,
paths: {
'/scrape': {
post: {
operationId: 'scrape',
requestBody: {
content: {
'application/json': {
schema: {
allOf: [
{ type: 'object', properties: { url: { type: 'string' } }, required: ['url'] },
{ $ref: '#/components/schemas/ScrapeOptions' },
],
} as OpenAPIV3.SchemaObject,
},
},
},
responses: { '200': { description: 'ok' } },
},
},
},
components: {
schemas: {
ScrapeOptions: {
type: 'object',
properties: {
formats: { type: 'array', items: { type: 'string' } },
onlyMainContent: { type: 'boolean' },
},
},
},
},
};

const { functionSignatures } = openapiToFunction(spec);
const scrape = functionSignatures.find((s) => s.name === 'scrape');

expect(scrape?.parameters.properties).toHaveProperty('url');
expect(scrape?.parameters.properties).toHaveProperty('formats');
expect(scrape?.parameters.properties).toHaveProperty('onlyMainContent');
expect(scrape?.parameters.required).toContain('url');
});

it('resolves $ref to a component that itself uses allOf', () => {
const spec: OpenAPIV3.Document = {
...baseSpec,
paths: {
'/scrape': {
post: {
operationId: 'scrape',
requestBody: {
content: {
'application/json': {
schema: { $ref: '#/components/schemas/ScrapeRequest' } as OpenAPIV3.ReferenceObject,
},
},
},
responses: { '200': { description: 'ok' } },
},
},
},
components: {
schemas: {
ScrapeRequest: {
allOf: [
{ type: 'object', properties: { url: { type: 'string' } }, required: ['url'] },
{ $ref: '#/components/schemas/ScrapeOptions' },
],
} as OpenAPIV3.SchemaObject,
ScrapeOptions: {
type: 'object',
properties: {
formats: { type: 'array', items: { type: 'string' } },
},
},
},
},
};

const { functionSignatures } = openapiToFunction(spec);
const scrape = functionSignatures.find((s) => s.name === 'scrape');

expect(scrape?.parameters.properties).toHaveProperty('url');
expect(scrape?.parameters.properties).toHaveProperty('formats');
expect(scrape?.parameters.required).toContain('url');
});

it('merges properties defined alongside allOf on the same schema object', () => {
const spec: OpenAPIV3.Document = {
...baseSpec,
paths: {
'/create': {
post: {
operationId: 'createThing',
requestBody: {
content: {
'application/json': {
schema: {
allOf: [
{ type: 'object', properties: { name: { type: 'string' } }, required: ['name'] },
],
properties: { extra: { type: 'number' } },
} as OpenAPIV3.SchemaObject,
},
},
},
responses: { '200': { description: 'ok' } },
},
},
},
};

const { functionSignatures } = openapiToFunction(spec);
const fn = functionSignatures.find((s) => s.name === 'createThing');

expect(fn?.parameters.properties).toHaveProperty('name');
expect(fn?.parameters.properties).toHaveProperty('extra');
expect(fn?.parameters.required).toContain('name');
});
});
});

describe('SSRF Protection', () => {
describe('extractDomainFromUrl', () => {
it('extracts domain from valid HTTPS URL', () => {
Expand Down
Loading
Loading