Skip to content

feat(ruby): add support for discriminated unions, enums, and undiscriminated unions in dynamic snippets #11099

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

Merged
iamnamananand996 merged 7 commits into from
Dec 9, 2025
Merged

feat(ruby): add support for discriminated unions, enums, and undiscriminated unions in dynamic snippets #11099

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
22f0825
feat(ruby-v2): add support for discriminated unions, enums, and undis…
devin-ai-integration[bot] Dec 8, 2025
f60c363
test(ruby): update snapshot for big-entity test with discriminated un…
devin-ai-integration[bot] Dec 8, 2025
c8cd99d
fix(ruby): handle non-object request body types (arrays, undiscrimina…
devin-ai-integration[bot] Dec 9, 2025
218ece2
chore(ruby):update seed
iamnamananand996 Dec 9, 2025
bdf0b4e
fix(ruby): prevent duplicate errors in undiscriminated union conversion
devin-ai-integration[bot] Dec 9, 2025
642742c
Merge branch 'namananand/fer-7972-twilio-dynamic-snippets-are-being-w…
devin-ai-integration[bot] Dec 9, 2025
06d60ac
bump version
iamnamananand996 Dec 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
158 changes: 147 additions & 11 deletions generators/ruby-v2/dynamic-snippets/src/EndpointSnippetGenerator.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -553,7 +553,7 @@ export class EndpointSnippetGenerator {
);

// Add body fields as keyword arguments
if (request.body != null) {
if (request.body != null && snippet.requestBody != null) {
switch (request.body.type) {
case "bytes":
// Not supported in Ruby snippets yet
Expand All @@ -563,22 +563,45 @@ export class EndpointSnippetGenerator {
});
break;
case "typeReference": {
// For typeReference bodies, we need to flatten the body fields into keyword arguments
// The Ruby SDK expects keyword args that get wrapped into the type by the method
const bodyRecord = this.context.getRecord(snippet.requestBody);
if (bodyRecord != null) {
// Get the type definition to understand the field names
const typeRef = request.body.value;
if (typeRef.type === "named") {
const namedType = this.context.resolveNamedType({ typeId: typeRef.value });
if (namedType != null) {
// Convert the body record fields to keyword arguments
const typeRef = request.body.value;

// Check if this is a named type that we can resolve
if (typeRef.type === "named") {
const namedType = this.context.resolveNamedType({ typeId: typeRef.value });
if (namedType != null && namedType.type === "object") {
// For objects, flatten the body fields into keyword arguments
const bodyRecord = this.context.getRecord(snippet.requestBody);
if (bodyRecord != null) {
const bodyFields = this.getBodyFieldsAsKeywordArgs({
namedType,
bodyRecord
});
args.push(...bodyFields);
}
} else if (namedType != null) {
// For non-object named types (undiscriminated unions, aliases, etc.),
// convert the entire body value and pass as a single 'request' keyword argument
const bodyArgs = this.getBodyArgsForNonObjectType({
namedType,
typeRef,
bodyValue: snippet.requestBody
});
args.push(...bodyArgs);
}
} else {
// For non-named type references (containers, primitives, etc.),
// convert the body value directly
const convertedValue = this.context.dynamicTypeLiteralMapper.convert({
typeReference: typeRef,
value: snippet.requestBody
});
if (!ruby.TypeLiteral.isNop(convertedValue)) {
args.push(
ruby.keywordArgument({
name: "request",
value: convertedValue
})
);
}
}
break;
Expand All @@ -591,6 +614,119 @@ export class EndpointSnippetGenerator {
return args;
}

private getBodyArgsForNonObjectType({
namedType,
typeRef,
bodyValue
}: {
namedType: FernIr.dynamic.NamedType;
typeRef: FernIr.dynamic.TypeReference;
bodyValue: unknown;
}): ruby.KeywordArgument[] {
const args: ruby.KeywordArgument[] = [];

switch (namedType.type) {
case "undiscriminatedUnion": {
// For undiscriminated unions, the body value should match one of the variants
// Try to convert it and extract the fields as keyword arguments
const bodyRecord = this.context.getRecord(bodyValue);
if (bodyRecord != null) {
// The body is an object - try to find a matching variant and extract its fields
for (const variant of namedType.types) {
if (variant.type === "named") {
const variantType = this.context.resolveNamedType({ typeId: variant.value });
if (variantType != null && variantType.type === "object") {
// Check if the body matches this variant's properties
const variantProps = new Set(variantType.properties.map((p) => p.name.wireValue));
const bodyKeys = Object.keys(bodyRecord);
const allKeysMatch = bodyKeys.every((key) => variantProps.has(key));
if (allKeysMatch && bodyKeys.length > 0) {
// This variant matches - flatten its fields
const bodyFields = this.getBodyFieldsAsKeywordArgs({
namedType: variantType,
bodyRecord
});
args.push(...bodyFields);
return args;
}
}
}
}
}
// If we couldn't match a variant or extract fields, convert the whole value
const convertedValue = this.context.dynamicTypeLiteralMapper.convert({
typeReference: typeRef,
value: bodyValue
});
if (!ruby.TypeLiteral.isNop(convertedValue)) {
args.push(
ruby.keywordArgument({
name: "request",
value: convertedValue
})
);
}
break;
}
case "alias": {
// For aliases, check if the underlying type is an object we can flatten
const aliasedType = namedType.typeReference;
if (aliasedType.type === "named") {
const resolvedAliasType = this.context.resolveNamedType({ typeId: aliasedType.value });
if (resolvedAliasType != null && resolvedAliasType.type === "object") {
const bodyRecord = this.context.getRecord(bodyValue);
if (bodyRecord != null) {
const bodyFields = this.getBodyFieldsAsKeywordArgs({
namedType: resolvedAliasType,
bodyRecord
});
args.push(...bodyFields);
return args;
}
}
}
// For non-object aliases (arrays, primitives, etc.), convert the whole value
const convertedValue = this.context.dynamicTypeLiteralMapper.convert({
typeReference: typeRef,
value: bodyValue
});
if (!ruby.TypeLiteral.isNop(convertedValue)) {
args.push(
ruby.keywordArgument({
name: "request",
value: convertedValue
})
);
}
break;
}
case "discriminatedUnion":
case "enum": {
// For discriminated unions and enums, convert the whole value
const convertedValue = this.context.dynamicTypeLiteralMapper.convert({
typeReference: typeRef,
value: bodyValue
});
if (!ruby.TypeLiteral.isNop(convertedValue)) {
args.push(
ruby.keywordArgument({
name: "request",
value: convertedValue
})
);
}
break;
}
case "object":
// This shouldn't happen as objects are handled separately
break;
default:
assertNever(namedType);
}

return args;
}

private getBodyFieldsAsKeywordArgs({
namedType,
bodyRecord
Expand Down
52 changes: 35 additions & 17 deletions ...ruby-v2/dynamic-snippets/src/__test__/__snapshots__/DynamicSnippetsGenerator.test.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,10 @@ exports[`snippets (default) > examples > 'POST /big-entity (simple)' 1`] = `
client = Acme::Client.new(token: '<YOUR_API_KEY>');

client.service.create_big_entity(
cast_member: {
id: 'john.doe',
name: 'John Doe'
},
extended_movie: {
cast: ['John Travolta', 'Samuel L. Jackson', 'Uma Thurman', 'Bruce Willis'],
id: 'movie-sda231x',
Expand All @@ -43,7 +47,8 @@ client.service.create_big_entity(
revenue: 1000000
},
migration: {
name: 'Migration 31 Aug'
name: 'Migration 31 Aug',
status: 'RUNNING'
}
);
"
Expand Down Expand Up @@ -109,30 +114,43 @@ exports[`snippets (default) > exhaustive > 'POST /container/list-of-objects (inv
"[
{
"severity": "CRITICAL",
"path": [],
"message": "Expected object with key, value pairs but got: array"
"path": [
"string"
],
"message": "Expected string, got boolean"
},
{
"severity": "CRITICAL",
"path": [
"string"
],
"message": "Expected string, got number"
}
]"
`;

exports[`snippets (default) > exhaustive > 'POST /container/list-of-objects (simp…' 1`] = `
"[
{
"severity": "CRITICAL",
"path": [],
"message": "Expected object with key, value pairs but got: array"
}
]"
"require "acme"

client = Acme::Client.new(token: '<YOUR_API_KEY>');

client.endpoints.container.get_and_return_list_of_objects(request: [{
string: 'one'
}, {
string: 'two'
}, {
string: 'three'
}]);
"
`;

exports[`snippets (default) > exhaustive > 'POST /container/list-of-primitives (s…' 1`] = `
"[
{
"severity": "CRITICAL",
"path": [],
"message": "Expected object with key, value pairs but got: array"
}
]"
"require "acme"

client = Acme::Client.new(token: '<YOUR_API_KEY>');

client.endpoints.container.get_and_return_list_of_primitives(request: ['one', 'two', 'three']);
"
`;

exports[`snippets (default) > file-upload > 'POST /' 1`] = `
Expand Down
Loading
Loading