@fern-api/fern-api-dev 5.23.3-1791-g4804e1e5883 → 5.23.3-1793-gf121e7de351

package/cli.cjs

@@ -59664,7 +59664,8 @@ var init_HttpInlineRequestBodySchema2 = __esm({
     HttpInlineRequestBodySchema = schemas_exports.object({
       extends: ObjectExtendsSchema.optional(),
       "extra-properties": schemas_exports.boolean().optional(),
-      properties: schemas_exports.record(schemas_exports.string(), HttpInlineRequestBodyPropertySchema).optional()
+      properties: schemas_exports.record(schemas_exports.string(), HttpInlineRequestBodyPropertySchema).optional(),
+      optional: schemas_exports.boolean().optional()
     });
   }
 });
@@ -139722,6 +139723,7 @@ var init_JsonRequest2 = __esm({
     JsonRequest = schemas_exports9.objectWithoutOptionalProperties({
       schema: schemas_exports9.lazy(() => Schema2),
       contentType: schemas_exports9.string().optional(),
+      required: schemas_exports9.boolean().optional(),
       additionalProperties: schemas_exports9.boolean()
     }).extend(WithDescription).extend(WithSource);
   }
@@ -141456,6 +141458,7 @@ var init_JsonRequestWithExample2 = __esm({
     JsonRequestWithExample = schemas_exports9.objectWithoutOptionalProperties({
       schema: schemas_exports9.lazy(() => SchemaWithExample2),
       contentType: schemas_exports9.string().optional(),
+      required: schemas_exports9.boolean().optional(),
       fullExamples: schemas_exports9.list(NamedFullExample).optional(),
       additionalProperties: schemas_exports9.boolean()
     }).extend(WithDescription).extend(WithSource).extend(WithSdkMethodName);
@@ -147296,6 +147299,9 @@ function getRequest({ endpoint: endpoint3, declarationFile, context: context3, r
     if (request7.additionalProperties) {
       requestBodySchema["extra-properties"] = true;
     }
+    if (request7.type === "json" && request7.required !== true) {
+      requestBodySchema.optional = true;
+    }
     const convertedRequestValue = {
       name: requestNameOverride ?? resolvedSchema.nameOverride ?? resolvedSchema.generatedName,
       "path-parameters": pathParameters,
@@ -166027,7 +166033,7 @@ function multipartRequestHasFile(multipartSchema, document4) {
     return !isReferenceObject(definition3) && definition3.type === "string" && (definition3.format === "binary" || definition3.format == null && definition3.contentMediaType === "application/octet-stream");
   }) != null;
 }
-function convertToSingleRequest({ content: content5, description, document: document4, context: context3, requestBreadcrumbs, source: source2, namespace }) {
+function convertToSingleRequest({ content: content5, description, document: document4, context: context3, requestBreadcrumbs, source: source2, namespace, bodyRequired }) {
   const octetStreamRequest = findOctetStreamRequest({ content: content5 });
   if (octetStreamRequest) {
     const [mediaType, mediaTypeObject] = octetStreamRequest;
@@ -166039,7 +166045,8 @@ function convertToSingleRequest({ content: content5, description, document: docu
       context: context3,
       requestBreadcrumbs,
       source: source2,
-      namespace
+      namespace,
+      bodyRequired
     });
   }
   const multipartFormDataRequest = findMultipartFormDataRequest({ content: content5, context: context3 });
@@ -166057,7 +166064,8 @@ function convertToSingleRequest({ content: content5, description, document: docu
         context: context3,
         requestBreadcrumbs,
         source: source2,
-        namespace
+        namespace,
+        bodyRequired
       }),
       multipart: ([mediaType, mediaTypeObject]) => convertRequest({
         mediaType,
@@ -166067,7 +166075,8 @@ function convertToSingleRequest({ content: content5, description, document: docu
         context: context3,
         requestBreadcrumbs,
         source: source2,
-        namespace
+        namespace,
+        bodyRequired
       }),
       neither: () => void 0
     }
@@ -166086,7 +166095,8 @@ function convertToSingleRequest({ content: content5, description, document: docu
       context: context3,
       requestBreadcrumbs,
       source: source2,
-      namespace
+      namespace,
+      bodyRequired
     });
   }
   return void 0;
@@ -166120,7 +166130,7 @@ function multipartOrJsonOrNone({ json: json2, multipart, document: document4, vi
   }
   return visitor.neither();
 }
-function convertRequest({ mediaType, mediaTypeObject, description, document: document4, context: context3, requestBreadcrumbs, source: source2, namespace }) {
+function convertRequest({ mediaType, mediaTypeObject, description, document: document4, context: context3, requestBreadcrumbs, source: source2, namespace, bodyRequired }) {
   const sdkMethodName = getRequestSdkMethodName({ mediaTypeObject });
   if (isOctetStreamRequest({ mediaType })) {
     return RequestWithExample.octetStream({
@@ -166188,6 +166198,7 @@ function convertRequest({ mediaType, mediaTypeObject, description, document: doc
       description: void 0,
       schema: requestSchema,
       contentType: jsonMediaObject.contentType,
+      required: bodyRequired,
       fullExamples: jsonMediaObject.examples,
       additionalProperties: !isReferenceObject(jsonMediaObject.schema) && isAdditionalPropertiesAny(jsonMediaObject.schema.additionalProperties, context3.options),
       source: source2,
@@ -166802,7 +166813,8 @@ function convertHttpOperation({ operationContext, context: context3, responseSta
           }),
           requestBreadcrumbs,
           source: source2,
-          namespace: context3.namespace
+          namespace: context3.namespace,
+          bodyRequired: resolvedRequestBody.required
         });
         if (endpointHasNonRequestBodyParameters({ context: context3, convertedParameters }) && convertedRequest != null && (convertedRequest.type === "json" || convertedRequest.type === "formUrlEncoded") && convertedRequest.schema.type !== "object" && operation.requestBody != null) {
           convertedRequest = convertRequest({
@@ -166813,7 +166825,8 @@ function convertHttpOperation({ operationContext, context: context3, responseSta
             context: context3,
             requestBreadcrumbs: [...requestBreadcrumbs, "Body"],
             source: source2,
-            namespace: context3.namespace
+            namespace: context3.namespace,
+            bodyRequired: resolvedRequestBody.required
           });
         } else if (operation.requestBody != null) {
           convertedRequest = convertRequest({
@@ -166824,7 +166837,8 @@ function convertHttpOperation({ operationContext, context: context3, responseSta
             context: context3,
             requestBreadcrumbs: [...requestBreadcrumbs],
             source: source2,
-            namespace: context3.namespace
+            namespace: context3.namespace,
+            bodyRequired: resolvedRequestBody.required
           });
         }
         return convertedRequest;
@@ -166847,7 +166861,8 @@ function convertHttpOperation({ operationContext, context: context3, responseSta
         }),
         requestBreadcrumbs,
         source: source2,
-        namespace: context3.namespace
+        namespace: context3.namespace,
+        bodyRequired: resolvedRequestBody.required
       });
       if (endpointHasNonRequestBodyParameters({ context: context3, convertedParameters }) && convertedRequest != null && (convertedRequest.type === "json" || convertedRequest.type === "formUrlEncoded") && convertedRequest.schema.type !== "object" && operation.requestBody != null) {
         convertedRequest = convertToSingleRequest({
@@ -166857,7 +166872,8 @@ function convertHttpOperation({ operationContext, context: context3, responseSta
           context: context3,
           requestBreadcrumbs: [...requestBreadcrumbs, "Body"],
           source: source2,
-          namespace: context3.namespace
+          namespace: context3.namespace,
+          bodyRequired: resolvedRequestBody.required
         });
       } else if (operation.requestBody != null) {
         convertedRequest = convertToSingleRequest({
@@ -166867,7 +166883,8 @@ function convertHttpOperation({ operationContext, context: context3, responseSta
           context: context3,
           requestBreadcrumbs: [...requestBreadcrumbs],
           source: source2,
-          namespace: context3.namespace
+          namespace: context3.namespace,
+          bodyRequired: resolvedRequestBody.required
         });
       }
       return [convertedRequest];
@@ -167600,7 +167617,10 @@ function convertWebhookOperation({ context: context3, operationContext, source:
     context: context3,
     requestBreadcrumbs: [...baseBreadcrumbs, "Payload"],
     source: source2,
-    namespace: context3.namespace
+    namespace: context3.namespace,
+    // carried for IR fidelity; a webhook payload is built as a type reference,
+    // so nothing downstream reads its requiredness today
+    bodyRequired: resolvedRequestBody.required
   })).filter((request7) => request7 != null).map((request7) => {
     if (request7 == null || request7.type !== "json" && request7.type !== "formUrlEncoded" && request7.type !== "multipart") {
       context3.logger.error(`Skipping webhook ${path121} because non-json, non-formUrlEncoded, and non-multipart request body`);
@@ -328273,6 +328293,17 @@ var init_fern_schema = __esm({
                 type: "null"
               }
             ]
+          },
+          optional: {
+            oneOf: [
+              {
+                type: "boolean"
+              },
+              {
+                type: "null"
+              }
+            ],
+            description: "Whether the endpoint may be called without a request body. When true, an\nexample may omit `request`. Populated from `requestBody.required` when\nimporting from OpenAPI.\n\nThis is read by example validation only: it is not carried into the IR, so it\ndoes not make the request parameter optional in a generated SDK."
           }
         },
         additionalProperties: false
@@ -332719,6 +332750,17 @@ var init_package_yml_schema = __esm({
                 type: "null"
               }
             ]
+          },
+          optional: {
+            oneOf: [
+              {
+                type: "boolean"
+              },
+              {
+                type: "null"
+              }
+            ],
+            description: "Whether the endpoint may be called without a request body. When true, an\nexample may omit `request`. Populated from `requestBody.required` when\nimporting from OpenAPI.\n\nThis is read by example validation only: it is not carried into the IR, so it\ndoes not make the request parameter optional in a generated SDK."
           }
         },
         additionalProperties: false
@@ -686962,7 +687004,8 @@ function visitEndpoint({ endpointId, endpoint: endpoint3, service, visitor, node
                   }
                 }
               },
-              ["extra-properties"]: noop2
+              ["extra-properties"]: noop2,
+              optional: noop2
             });
           } else {
             createDocsVisitor(visitor, nodePathForRequestBody)(body.docs);
@@ -690006,6 +690049,16 @@ function validateRequest({ example, endpoint: endpoint3, typeResolver, exampleRe
       });
     }
   } else if (isInlineRequestBody(body)) {
+    if (example == null) {
+      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."
+      });
+      return violations;
+    }
     violations.push(...examples_exports6.validateObjectExample({
       typeName: void 0,
       typeNameForBreadcrumb: "<Inlined Request>",
@@ -702583,7 +702636,7 @@ var AccessTokenPosthogManager = class {
         properties: {
           ...event,
           ...event.properties,
-          version: "5.23.3-1791-g4804e1e5883",
+          version: "5.23.3-1793-gf121e7de351",
           usingAccessToken: true,
           ...getRunIdProperties()
         }
@@ -702649,7 +702702,7 @@ var UserPosthogManager = class {
       distinctId: this.userId ?? await this.getPersistedDistinctId(),
       event: "CLI",
       properties: {
-        version: "5.23.3-1791-g4804e1e5883",
+        version: "5.23.3-1793-gf121e7de351",
         ...event,
         ...event.properties,
         usingAccessToken: false,
@@ -883813,7 +883866,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.23.3-1791-g4804e1e5883";
+  const version7 = "5.23.3-1793-gf121e7de351";
   return `cli@${version7}`;
 }
 var DebugLogger = class {
@@ -909129,7 +909182,7 @@ var LegacyDocsPublisher = class {
         previewId,
         disableTemplates: void 0,
         skipUpload,
-        cliVersion: "5.23.3-1791-g4804e1e5883",
+        cliVersion: "5.23.3-1793-gf121e7de351",
         loginCommand: "fern auth login"
       });
       if (taskContext.getResult() === TaskResult.Failure) {
@@ -976038,7 +976091,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.23.3-1791-g4804e1e5883"
+    cli_version: "5.23.3-1793-gf121e7de351"
   };
 }
 function isAutomationMode() {
@@ -976870,7 +976923,7 @@ var CliContext = class _CliContext {
     if (false) {
       this.logger.error("CLI_VERSION is not defined");
     }
-    return "5.23.3-1791-g4804e1e5883";
+    return "5.23.3-1793-gf121e7de351";
   }
   getCliName() {
     if (false) {

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "5.23.3-1791-g4804e1e5883",
+  "version": "5.23.3-1793-gf121e7de351",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/fern-api/fern.git",