@fern-api/fern-api-dev 5.91.0 → 5.92.0

package/cli.cjs

@@ -130864,6 +130864,7 @@ var init_OpenApiSettingsSchema2 = __esm({
       "respect-readonly-schemas": schemas_exports8.boolean().optional(),
       "use-read-variant-for-responses": schemas_exports8.boolean().optional(),
       "respect-forward-compatible-enums": schemas_exports8.boolean().optional(),
+      "respect-optional-request-body": schemas_exports8.boolean().optional(),
       "use-bytes-for-binary-response": schemas_exports8.boolean().optional(),
       "default-form-parameter-encoding": FormParameterEncoding2.optional(),
       filter: OpenApiFilterSchema.optional(),
@@ -132397,6 +132398,7 @@ var init_ConvertOpenAPIOptions = __esm({
       respectNullableSchemas: true,
       onlyIncludeReferencedSchemas: false,
       inlinePathParameters: true,
+      respectOptionalRequestBody: false,
       useBytesForBinaryResponse: false,
       respectForwardCompatibleEnums: false,
       wrapReferencesToNullableInOptional: false,
@@ -147143,6 +147145,12 @@ function getRequest({ endpoint: endpoint3, declarationFile, context: context3, r
         requestValue.docs = request7.description;
       }
       const canCollapse = typeof requestValue.body === "string" && requestValue["path-parameters"] == null && requestValue["query-parameters"] == null && requestValue.headers == null && requestValue.name == null && requestValue.docs == null && (requestValue["content-type"] == null || requestValue["content-type"] === "application/json");
+      if (context3.options.respectOptionalRequestBody && isOptionalJsonBody(request7)) {
+        requestValue.body = typeof requestTypeReference === "string" ? wrapTypeReferenceInOptional(requestTypeReference) : {
+          ...requestTypeReference,
+          type: wrapTypeReferenceInOptional(requestTypeReference.type)
+        };
+      }
       return {
         schemaIdsToExclude: [],
         value: canCollapse ? requestValue.body : requestValue
@@ -147299,7 +147307,7 @@ function getRequest({ endpoint: endpoint3, declarationFile, context: context3, r
     if (request7.additionalProperties) {
       requestBodySchema["extra-properties"] = true;
     }
-    if (request7.type === "json" && request7.required !== true) {
+    if (isOptionalJsonBody(request7)) {
       requestBodySchema.optional = true;
     }
     const convertedRequestValue = {
@@ -147398,6 +147406,12 @@ function getRequest({ endpoint: endpoint3, declarationFile, context: context3, r
     assertNever(request7);
   }
 }
+function isOptionalJsonBody(request7) {
+  return request7.type === "json" && request7.required !== true;
+}
+function wrapTypeReferenceInOptional(typeReference2) {
+  return typeReference2.startsWith("optional<") ? typeReference2 : `optional<${typeReference2}>`;
+}
 function endpointRequestSupportsInlinedPathParameters({ context: context3, request: request7 }) {
   if (!context3.options.inlinePathParameters) {
     return false;
@@ -151775,6 +151789,7 @@ var init_BaseOpenAPIWorkspace = __esm({
       exampleGeneration;
       useBytesForBinaryResponse;
       respectForwardCompatibleEnums;
+      respectOptionalRequestBody;
       inlineAllOfSchemas;
       resolveAliases;
       groupEnvironmentsByHost;
@@ -151799,6 +151814,7 @@ var init_BaseOpenAPIWorkspace = __esm({
         this.exampleGeneration = args.exampleGeneration;
         this.useBytesForBinaryResponse = args.useBytesForBinaryResponse;
         this.respectForwardCompatibleEnums = args.respectForwardCompatibleEnums;
+        this.respectOptionalRequestBody = args.respectOptionalRequestBody;
         this.inlineAllOfSchemas = args.inlineAllOfSchemas;
         this.resolveAliases = args.resolveAliases;
         this.groupEnvironmentsByHost = args.groupEnvironmentsByHost;
@@ -167249,6 +167265,7 @@ function getRequestBody2({ context: context3, operation, streamingExtension, isS
   };
   return {
     requestBody: {
+      required: resolvedRequestBody.required,
       content: {
         [MediaType.APPLICATION_JSON]: {
           schema: requestBodySchemaWithLiteralProperty
@@ -199882,6 +199899,7 @@ var init_getAPIDefinitionSettings = __esm({
       inlinePathParameters: "inlinePathParameters",
       useBytesForBinaryResponse: "useBytesForBinaryResponse",
       respectForwardCompatibleEnums: "respectForwardCompatibleEnums",
+      respectOptionalRequestBody: "respectOptionalRequestBody",
       filter: "filter",
       defaultFormParameterEncoding: "defaultFormParameterEncoding",
       exampleGeneration: "exampleGeneration",
@@ -264186,6 +264204,7 @@ function parseOpenApiDefinitionSettingsSchema(settings) {
     defaultFormParameterEncoding: settings?.["default-form-parameter-encoding"],
     useBytesForBinaryResponse: settings?.["use-bytes-for-binary-response"],
     respectForwardCompatibleEnums: settings?.["respect-forward-compatible-enums"],
+    respectOptionalRequestBody: settings?.["respect-optional-request-body"],
     additionalPropertiesDefaultsTo: settings?.["additional-properties-defaults-to"],
     typeDatesAsStrings: settings?.["type-dates-as-strings"],
     preserveSingleSchemaOneOf: settings?.["preserve-single-schema-oneof"],
@@ -265042,6 +265061,7 @@ var init_convertGeneratorsConfiguration = __esm({
       inlinePathParameters: void 0,
       useBytesForBinaryResponse: void 0,
       respectForwardCompatibleEnums: void 0,
+      respectOptionalRequestBody: void 0,
       filter: void 0,
       exampleGeneration: void 0,
       defaultFormParameterEncoding: void 0,
@@ -275421,6 +275441,10 @@ function convertHeaders({ service, endpoint: endpoint3, example, typeResolver, e
     serviceHeaders
   };
 }
+function isOptionalType({ rawType, typeResolver, file: file4 }) {
+  const resolvedType = typeResolver.resolveType({ type: rawType, file: file4 });
+  return resolvedType?._type === "container" && resolvedType.container._type === "optional";
+}
 function convertExampleRequestBody({ endpoint: endpoint3, example, typeResolver, exampleResolver, file: file4, workspace }) {
   const requestType = typeof endpoint3.request !== "string" ? endpoint3.request?.body : endpoint3.request;
   if (requestType == null) {
@@ -275430,9 +275454,13 @@ function convertExampleRequestBody({ endpoint: endpoint3, example, typeResolver,
     return void 0;
   }
   if (!isInlineRequestBody(requestType)) {
+    const rawTypeBeingExemplified = typeof requestType !== "string" ? requestType.type : requestType;
+    if (example.request === void 0 && isOptionalType({ rawType: rawTypeBeingExemplified, typeResolver, file: file4 })) {
+      return void 0;
+    }
     return ExampleRequestBody.reference(convertTypeReferenceExample({
       example: example.request,
-      rawTypeBeingExemplified: typeof requestType !== "string" ? requestType.type : requestType,
+      rawTypeBeingExemplified,
       typeResolver,
       exampleResolver,
       fileContainingRawTypeReference: file4,
@@ -372145,6 +372173,7 @@ var init_OSSWorkspace = __esm({
           objectQueryParameters: collapseSpecBooleanSetting(specs, (s5) => s5?.objectQueryParameters),
           useBytesForBinaryResponse: collapseSpecBooleanSetting(openapiSpecs, (s5) => s5?.useBytesForBinaryResponse),
           respectForwardCompatibleEnums: collapseSpecBooleanSetting(openapiSpecs, (s5) => s5?.respectForwardCompatibleEnums),
+          respectOptionalRequestBody: collapseSpecBooleanSetting(openapiSpecs, (s5) => s5?.respectOptionalRequestBody),
           inlineAllOfSchemas: collapseSpecBooleanSetting(specs, (s5) => s5?.inlineAllOfSchemas),
           resolveAliases: (() => {
             const values2 = specs.map((spec) => spec.settings?.resolveAliases);
@@ -690038,6 +690067,10 @@ function validateExampleEndpointCallParameters({ allDeclarations = {}, examples,
 // ../fern-definition/validator/lib/rules/valid-example-endpoint-call/validateRequest.js
 init_lib10();
 init_lib23();
+var REQUIRED_REQUEST_BODY_VIOLATION = {
+  severity: "fatal",
+  message: "This endpoint requires a request body, so its examples must specify request. Mark the body optional to allow calling the endpoint without one."
+};
 function validateRequest({ example, endpoint: endpoint3, typeResolver, exampleResolver, file: file4, workspace }) {
   const violations = [];
   const body = typeof endpoint3.request !== "string" ? endpoint3.request?.body : endpoint3.request;
@@ -690049,14 +690082,11 @@ function validateRequest({ example, endpoint: endpoint3, typeResolver, exampleRe
       });
     }
   } else if (isInlineRequestBody(body)) {
-    if (example == null) {
+    if (example === void 0) {
       if (body.optional) {
         return violations;
       }
-      violations.push({
-        severity: "fatal",
-        message: "This endpoint requires a request body, so its examples must specify request. Mark the body optional to allow calling the endpoint without one."
-      });
+      violations.push(REQUIRED_REQUEST_BODY_VIOLATION);
       return violations;
     }
     violations.push(...examples_exports6.validateObjectExample({
@@ -690078,7 +690108,7 @@ function validateRequest({ example, endpoint: endpoint3, typeResolver, exampleRe
       return { severity: val.severity ?? "fatal", message: val.message };
     }));
   } else {
-    violations.push(...examples_exports6.validateTypeReferenceExample({
+    const bodyViolations = examples_exports6.validateTypeReferenceExample({
       rawTypeReference: typeof body === "string" ? body : body.type,
       example,
       file: file4,
@@ -690089,7 +690119,12 @@ function validateRequest({ example, endpoint: endpoint3, typeResolver, exampleRe
       depth: 0
     }).map((val) => {
       return { severity: val.severity ?? "fatal", message: val.message };
-    }));
+    });
+    if (example === void 0 && bodyViolations.length > 0) {
+      violations.push(REQUIRED_REQUEST_BODY_VIOLATION);
+      return violations;
+    }
+    violations.push(...bodyViolations);
   }
   return violations;
 }
@@ -693977,6 +694012,8 @@ var OpenApiSettingsSchema2 = BaseApiSettingsSchema2.extend({
   useReadVariantForResponses: external_exports.boolean().optional(),
   /** Enables respecting forward compatible enums in OpenAPI specifications. Defaults to false. */
   respectForwardCompatibleEnums: external_exports.boolean().optional(),
+  /** Enables making a JSON request body that OpenAPI does not mark as required optional in the generated SDK, so callers may omit the body. Defaults to false. */
+  respectOptionalRequestBody: external_exports.boolean().optional(),
   /** Enables using the `bytes` type for binary responses in OpenAPI specifications. Defaults to a file stream. */
   useBytesForBinaryResponse: external_exports.boolean().optional(),
   /** The default encoding of form parameters. Defaults to JSON. */
@@ -702636,7 +702673,7 @@ var AccessTokenPosthogManager = class {
         properties: {
           ...event,
           ...event.properties,
-          version: "5.91.0",
+          version: "5.92.0",
           usingAccessToken: true,
           ...getRunIdProperties()
         }
@@ -702702,7 +702739,7 @@ var UserPosthogManager = class {
       distinctId: this.userId ?? await this.getPersistedDistinctId(),
       event: "CLI",
       properties: {
-        version: "5.91.0",
+        version: "5.92.0",
         ...event,
         ...event.properties,
         usingAccessToken: false,
@@ -709502,6 +709539,7 @@ var LegacyApiSpecAdapter = class {
       shouldUseUndiscriminatedUnionsWithLiterals: settings.preferUndiscriminatedUnionsWithLiterals,
       objectQueryParameters: settings.objectQueryParameters,
       respectForwardCompatibleEnums: settings.respectForwardCompatibleEnums,
+      respectOptionalRequestBody: settings.respectOptionalRequestBody,
       useBytesForBinaryResponse: settings.useBytesForBinaryResponse,
       defaultFormParameterEncoding: settings.defaultFormParameterEncoding,
       filter: settings.filter,
@@ -881950,6 +881988,7 @@ var SETTINGS_KEY_MAP = {
   "respect-readonly-schemas": "respectReadonlySchemas",
   "use-read-variant-for-responses": "useReadVariantForResponses",
   "respect-forward-compatible-enums": "respectForwardCompatibleEnums",
+  "respect-optional-request-body": "respectOptionalRequestBody",
   "use-bytes-for-binary-response": "useBytesForBinaryResponse",
   "default-form-parameter-encoding": "defaultFormParameterEncoding",
   "example-generation": "exampleGeneration",
@@ -883866,7 +883905,7 @@ var LOCAL_STORAGE_FOLDER4 = ".fern-dev";
 var LOGS_FOLDER_NAME = "logs";
 var MAX_LOGS_DIR_SIZE_BYTES = 100 * 1024 * 1024;
 function getCliSource() {
-  const version7 = "5.91.0";
+  const version7 = "5.92.0";
   return `cli@${version7}`;
 }
 var DebugLogger = class {
@@ -909182,7 +909221,7 @@ var LegacyDocsPublisher = class {
         previewId,
         disableTemplates: void 0,
         skipUpload,
-        cliVersion: "5.91.0",
+        cliVersion: "5.92.0",
         loginCommand: "fern auth login"
       });
       if (taskContext.getResult() === TaskResult.Failure) {
@@ -961708,7 +961747,10 @@ var EndpointSnippetGenerator9 = class {
     this.context.errors.unscope();
     this.context.errors.scope(Scope4.RequestBody);
     if (request7.body != null) {
-      args.push(this.getBodyRequestArg({ body: request7.body, value: snippet.requestBody }));
+      const bodyArg = this.getBodyRequestArg({ body: request7.body, value: snippet.requestBody });
+      if (!typescript_exports.TypeLiteral.isNop(bodyArg)) {
+        args.push(bodyArg);
+      }
     }
     this.context.errors.unscope();
     return args;
@@ -961831,8 +961873,10 @@ var EndpointSnippetGenerator9 = class {
     switch (body.type) {
       case "properties":
         return this.getInlinedRequestBodyPropertyObjectFields({ parameters: body.value, value: value2 });
-      case "referenced":
-        return [this.getReferencedRequestBodyPropertyObjectField({ body, value: value2 })];
+      case "referenced": {
+        const field5 = this.getReferencedRequestBodyPropertyObjectField({ body, value: value2 });
+        return typescript_exports.TypeLiteral.isNop(field5.value) ? [] : [field5];
+      }
       case "fileUpload":
         return this.getFileUploadRequestBodyObjectFields({ filePropertyInfo });
       default:
@@ -976091,7 +976135,7 @@ function getAutomationContextFromEnv() {
     config_branch: process.env.FERN_CONFIG_BRANCH,
     config_pr_number: process.env.FERN_CONFIG_PR_NUMBER,
     trigger: process.env.GITHUB_EVENT_NAME,
-    cli_version: "5.91.0"
+    cli_version: "5.92.0"
   };
 }
 function isAutomationMode() {
@@ -976923,7 +976967,7 @@ var CliContext = class _CliContext {
     if (false) {
       this.logger.error("CLI_VERSION is not defined");
     }
-    return "5.91.0";
+    return "5.92.0";
   }
   getCliName() {
     if (false) {

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "5.91.0",
+  "version": "5.92.0",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/fern-api/fern.git",