n8n-nodes-base/dist/node-definitions/nodes/n8n-nodes-base/httpRequest/v2.schema.js

Base nodes of n8n

/**
 * HTTP Request Node - Version 2 - Zod Validation Schemas
 *
 * These schemas validate node configuration at runtime.
 * Use .parse() for strict validation or .safeParse() for error handling.
 *
 * Schema helpers (z, expressionSchema, etc.) are passed as parameters
 * by the schema-validator, not imported from external files.
 *
 * @generated - CommonJS JavaScript for runtime loading
 */

module.exports = function getSchema({ parameters, z, expressionSchema, stringOrExpression, numberOrExpression, booleanOrExpression, resourceLocatorValueSchema, resourceMapperValueSchema, filterValueSchema, assignmentCollectionValueSchema, iDataObjectSchema, resolveSchema }) {

  // Parameters schema
  const parametersSchema = z.object({
    authentication: z.union([z.literal('none'), z.literal('predefinedCredentialType'), z.literal('genericCredentialType')]).optional(),
    nodeCredentialType: resolveSchema({ parameters, schema: z.string(), required: false, displayOptions: {"show":{"authentication":["predefinedCredentialType"]}}, defaults: {"authentication":"none"} }),
    genericAuthType: resolveSchema({ parameters, schema: z.union([z.literal('httpBasicAuth'), z.literal('httpBearerAuth'), z.literal('httpDigestAuth'), z.literal('httpHeaderAuth'), z.literal('httpQueryAuth'), z.literal('httpCustomAuth'), z.literal('oAuth1Api'), z.literal('oAuth2Api'), expressionSchema]), required: false, displayOptions: {"show":{"authentication":["genericCredentialType"]}}, defaults: {"authentication":"none"} }),
    requestMethod: z.union([z.literal('DELETE'), z.literal('GET'), z.literal('HEAD'), z.literal('OPTIONS'), z.literal('PATCH'), z.literal('POST'), z.literal('PUT'), expressionSchema]).optional(),
    url: stringOrExpression.optional(),
    allowUnauthorizedCerts: booleanOrExpression.optional(),
    responseFormat: z.union([z.literal('file'), z.literal('json'), z.literal('string'), expressionSchema]).optional(),
    dataPropertyName: resolveSchema({ parameters, schema: stringOrExpression, required: false, displayOptions: {"show":{"responseFormat":["string","file"]}}, defaults: {"responseFormat":"json"} }),
    jsonParameters: booleanOrExpression.optional(),
    options: z.object({ batchInterval: numberOrExpression.optional(), batchSize: numberOrExpression.optional(), bodyContentType: z.union([z.literal('json'), z.literal('raw'), z.literal('multipart-form-data'), z.literal('form-urlencoded'), expressionSchema]).optional(), fullResponse: booleanOrExpression.optional(), followAllRedirects: booleanOrExpression.optional(), followRedirect: booleanOrExpression.optional(), ignoreResponseCode: booleanOrExpression.optional(), bodyContentCustomMimeType: stringOrExpression.optional(), proxy: stringOrExpression.optional(), splitIntoItems: booleanOrExpression.optional(), timeout: numberOrExpression.optional(), useQueryString: booleanOrExpression.optional() }).optional(),
    sendBinaryData: resolveSchema({ parameters, schema: booleanOrExpression, required: false, displayOptions: {"show":{"jsonParameters":[true],"requestMethod":["PATCH","POST","PUT"]}}, defaults: {"jsonParameters":false,"requestMethod":"GET"} }),
    binaryPropertyName: resolveSchema({ parameters, schema: stringOrExpression, required: false, displayOptions: {"show":{"jsonParameters":[true],"requestMethod":["PATCH","POST","PUT"]},"hide":{"sendBinaryData":[false]}}, defaults: {"jsonParameters":false,"requestMethod":"GET","sendBinaryData":false} }),
    bodyParametersJson: resolveSchema({ parameters, schema: z.union([iDataObjectSchema, z.string()]), required: false, displayOptions: {"show":{"jsonParameters":[true],"requestMethod":["PATCH","POST","PUT","DELETE"]},"hide":{"sendBinaryData":[true]}}, defaults: {"jsonParameters":false,"requestMethod":"GET","sendBinaryData":false} }),
    bodyParametersUi: resolveSchema({ parameters, schema: z.object({ parameter: z.array(z.object({ name: stringOrExpression.optional(), value: stringOrExpression.optional() })).optional() }), required: false, displayOptions: {"show":{"jsonParameters":[false],"requestMethod":["PATCH","POST","PUT","DELETE"]}}, defaults: {"jsonParameters":false,"requestMethod":"GET"} }),
    headerParametersJson: resolveSchema({ parameters, schema: z.union([iDataObjectSchema, z.string()]), required: false, displayOptions: {"show":{"jsonParameters":[true]}}, defaults: {"jsonParameters":false} }),
    headerParametersUi: resolveSchema({ parameters, schema: z.object({ parameter: z.array(z.object({ name: stringOrExpression.optional(), value: stringOrExpression.optional() })).optional() }), required: false, displayOptions: {"show":{"jsonParameters":[false]}}, defaults: {"jsonParameters":false} }),
    queryParametersJson: resolveSchema({ parameters, schema: z.union([iDataObjectSchema, z.string()]), required: false, displayOptions: {"show":{"jsonParameters":[true]}}, defaults: {"jsonParameters":false} }),
    queryParametersUi: resolveSchema({ parameters, schema: z.object({ parameter: z.array(z.object({ name: stringOrExpression.optional(), value: stringOrExpression.optional() })).optional() }), required: false, displayOptions: {"show":{"jsonParameters":[false]}}, defaults: {"jsonParameters":false} }),
  });

  // Return combined config schema
  return z.object({
    parameters: parametersSchema.optional(),
  });
};