Skip to content

Correct parameter handling in Go example generation script #566

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
justinpolygon merged 1 commit into from
Feb 24, 2026
Merged

Correct parameter handling in Go example generation script #566

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
23 changes: 14 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,32 +32,37 @@ import (
"context"
"fmt"
"log"
"os"

"github.com/massive-com/client-go/v3/rest"
"github.com/massive-com/client-go/v3/rest/gen"
)

func main() {
c := rest.NewWithOptions(os.Getenv("MASSIVE_API_KEY"),

c := rest.NewWithOptions("YOUR_API_KEY",
rest.WithTrace(false),
rest.WithPagination(true),
)
ctx := context.Background()

resp, err := c.GetStocksAggregatesWithResponse(ctx,
params := &gen.GetStocksAggregatesParams{
Adjusted: rest.Ptr(true),
Sort: "asc",
Limit: rest.Ptr(120),
}

resp, err := c.GetStocksAggregatesWithResponse(
ctx,
"AAPL",
1,
gen.GetStocksAggregatesParamsTimespan("day"),
"2025-11-03",
"2025-11-28",
nil, // nil = use API defaults (recommended)
"day",
"2026-02-16",
"2026-02-20",
params,
)
if err != nil {
log.Fatal(err)
}

// prints status + full error body (e.g. "Unknown API Key")
if err := rest.CheckResponse(resp); err != nil {
log.Fatal(err)
}
Expand Down
134 changes: 75 additions & 59 deletions rest/scripts/generate-go-examples.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ if (!fs.existsSync(tokenizedDir)) fs.mkdirSync(tokenizedDir, { recursive: true }
// === Helpers ===
const toPascalCase = (str) => {
return str
.replace(/([a-z0-9])([A-Z])/g, '$1 $2') // split camelCase
.replace(/([a-z0-9])([A-Z])/g, '$1 $2')
.split(/[-_ ]+/)
.map(word => word.charAt(0).toUpperCase() + word.slice(1).toLowerCase())
.join('');
Expand Down Expand Up @@ -39,11 +39,6 @@ const toSnakeCase = (str) =>
.replace(/[-\/.]/g, '_')
.toLowerCase();

const isIntField = (param) => {
const type = param.schema?.type || 'string';
return type === 'integer' || type === 'number';
};

const isPaginated = (details) => {
const successResp = details.responses?.['200'] || details.responses?.default;
if (!successResp?.content?.['application/json']?.schema) return false;
Expand All @@ -56,18 +51,37 @@ const isEnumParam = (param) => {
return Array.isArray(param.schema.enum) || !!param.schema.$ref;
};

// NEW helper: decides whether a TOKEN_ should be wrapped in quotes in the tokenized version
const shouldUseTypedEnum = (param) => {
return !!param.schema?.$ref || param.schema?.default !== undefined;
};

const isStringParam = (param) => {
if (!param?.schema) return true; // most path params + unknown fields default to string
if (!param?.schema) return true;
const schema = param.schema;
const type = schema.type;
if (type === 'string' || !type) return true;
if (type === 'integer' || type === 'number' || type === 'boolean') return false;
// enums / $refs / arrays-of-strings are string-like
return Array.isArray(schema.enum) || !!schema.$ref ||
(schema.type === 'array' && schema.items?.type === 'string');
};

const getParamValue = (param, useTokens = false) => {
if (useTokens) {
const token = toPolygonToken(param.name);
return isStringParam(param) ? `"${token}"` : token;
}

let value = param.example ?? param.schema?.example ?? param.schema?.default;
if (value !== undefined) {
return typeof value === 'string' ? `"${value}"` : value;
}

const schemaType = param.schema?.type || 'string';
if (schemaType === 'boolean') return 'true';
if (schemaType === 'integer' || schemaType === 'number') return '100';
return `"${param.name}"`;
};

Object.entries(spec.paths).forEach(([route, methods]) => {
Object.entries(methods).forEach(([httpMethod, details]) => {
const operationId = details.operationId;
Expand All @@ -78,8 +92,11 @@ Object.entries(spec.paths).forEach(([route, methods]) => {
const paramsType = goBaseName + 'Params';
const fileName = toSnakeCase(operationId);

// Collect full path param objects (so we have .schema for type detection)
const pathParams = (details.parameters || []).filter(p => p.in === 'path');
const allParams = details.parameters || [];
const pathParams = allParams.filter(p => p.in === 'path');
const queryParams = allParams.filter(p => p.in === 'query');

const hasQueryParams = queryParams.length > 0;

const generateSnippet = (dir, useTokens = false) => {
const lines = [
Expand All @@ -89,68 +106,67 @@ Object.entries(spec.paths).forEach(([route, methods]) => {
` "context"`,
` "fmt"`,
` "log"`,
` "massive-go-poc/rest"`,
` "massive-go-poc/rest/gen"`,
`)`,
``,
`func main() {`,
``,
` c := rest.NewWithOptions("YOUR_API_KEY", rest.WithTrace(false), rest.WithPagination(true))`,
` ctx := context.Background()`,
``,
//` params := &gen.${paramsType}{`,
` "github.com/massive-com/client-go/v3/rest"`,
];

if (hasQueryParams) {
lines.push(` "github.com/massive-com/client-go/v3/rest/gen"`);
}

lines.push(`)`);
lines.push(``);
lines.push(`func main() {`);
lines.push(``);

lines.push(` c := rest.NewWithOptions("GLOBAL_TOKEN_API_KEY",`);
lines.push(` rest.WithTrace(false),`);
lines.push(` rest.WithPagination(true),`);
lines.push(` )`);
lines.push(` ctx := context.Background()`);
lines.push(``);

// === Build query param lines (extra indent for inline struct) ===
const paramLines = [];
if (details.parameters) {
details.parameters.forEach(param => {
if (param.in === 'query') {
const fieldName = toGoFieldName(param.name);
const schemaType = param.schema?.type || 'string';
if (hasQueryParams) {
lines.push(` params := &gen.${paramsType}{`);

let value;
if (useTokens) {
const token = toPolygonToken(param.name);
value = isStringParam(param) ? `"${token}"` : token;
} else {
if (schemaType === 'boolean') value = 'true';
else if (schemaType === 'integer' || schemaType === 'number') value = '100';
else value = param.example !== undefined
? (typeof param.example === 'string' ? `"${param.example}"` : param.example)
: `"${param.name}"`;
}
const paramLines = [];
queryParams.forEach(param => {
const fieldName = toGoFieldName(param.name);
const value = getParamValue(param, useTokens);

let line;
if (isEnumParam(param)) {
line = ` ${fieldName}: rest.Ptr(gen.${paramsType}${fieldName}(${value})),`;
let line;
if (isEnumParam(param)) {
if (shouldUseTypedEnum(param)) {
line = ` ${fieldName}: rest.Ptr(gen.${paramsType}${fieldName}(${value})),`;
} else {
line = ` ${fieldName}: rest.Ptr(${value}),`;
line = ` ${fieldName}: ${value},`;
}
paramLines.push(line);
} else {
line = ` ${fieldName}: rest.Ptr(${value}),`;
}
paramLines.push(line);
});
}

// === Multi-line call with inline params (exactly the style you wanted) ===
const pathArgs = pathParams.map(param => {
if (!useTokens) return `"${param.name}"`;
const token = toPolygonToken(param.name);
return isStringParam(param) ? `"${token}"` : token;
});
lines.push(paramLines.join('\n'));
lines.push(` }`);
lines.push(``);
}

lines.push(` resp, err := c.${goMethod}(ctx,`);
// === UNIFORM MULTILINE CALL FOR EVERY ENDPOINT (fixes the syntax error) ===
// Every argument (including ctx) is now on its own line → perfect for token replacement
lines.push(` resp, err := c.${goMethod}(`);
lines.push(` ctx,`);

pathArgs.forEach(arg => {
lines.push(` ${arg},`);
// Path parameters (if any)
pathParams.forEach(param => {
const value = getParamValue(param, useTokens);
lines.push(` ${value},`);
});

lines.push(` &gen.${paramsType}{`);
if (paramLines.length > 0) {
lines.push(paramLines.join('\n'));
// Query params struct (if any)
if (hasQueryParams) {
lines.push(` params,`);
}
lines.push(` },`);

lines.push(` )`);

lines.push(` if err != nil {`);
Expand Down Expand Up @@ -186,4 +202,4 @@ Object.entries(spec.paths).forEach(([route, methods]) => {
});
});

console.log('🎉 All Go examples generated with string tokens properly quoted in the tokenized version!');
console.log('🎉 All Go examples generated.');
Loading