@awsless/awsless 0.0.478 → 0.0.479

package/dist/build-json-schema.js

@@ -844,10 +844,21 @@ var LocalEntrySchema = z28.union([
 
 // src/feature/site/schema.ts
 var ErrorResponsePathSchema = z29.string().describe(
-  "The path to the custom error page that you want to return to the viewer when your origin returns the HTTP status code specified.\n - We recommend that you store custom error pages in an Amazon S3 bucket. If you store custom error pages on an HTTP server and the server starts to return 5xx errors, CloudFront can't get the files that you want to return to viewers because the origin server is unavailable."
+  [
+    "The path to the custom error page that you want to return to the viewer when your origin returns the HTTP status code specified.",
+    "- We recommend that you store custom error pages in an Amazon S3 bucket.",
+    "If you store custom error pages on an HTTP server and the server starts to return 5xx errors, CloudFront can't get the files that you want to return to viewers because the origin server is unavailable."
+  ].join("\n")
 );
 var StatusCodeSchema = z29.number().int().positive().optional().describe(
-  "The HTTP status code that you want CloudFront to return to the viewer along with the custom error page. There are a variety of reasons that you might want CloudFront to return a status code different from the status code that your origin returned to CloudFront, for example:\n- Some Internet devices (some firewalls and corporate proxies, for example) intercept HTTP 4xx and 5xx and prevent the response from being returned to the viewer. If you substitute 200, the response typically won't be intercepted.\n- If you don't care about distinguishing among different client errors or server errors, you can specify 400 or 500 as the ResponseCode for all 4xx or 5xx errors.\n- You might want to return a 200 status code (OK) and static website so your customers don't know that your website is down."
+  [
+    "The HTTP status code that you want CloudFront to return to the viewer along with the custom error page.",
+    "There are a variety of reasons that you might want CloudFront to return a status code different from the status code that your origin returned to CloudFront, for example:",
+    "- Some Internet devices (some firewalls and corporate proxies, for example) intercept HTTP 4xx and 5xx and prevent the response from being returned to the viewer.",
+    "If you substitute 200, the response typically won't be intercepted.",
+    `- If you don't care about distinguishing among different client errors or server errors, you can specify 400 or 500 as the ResponseCode for all 4xx or 5xx errors.`,
+    `- You might want to return a 200 status code (OK) and static website so your customers don't know that your website is down.`
+  ].join("\n")
 );
 var MinTTLSchema = DurationSchema.describe(
   "The minimum amount of time, that you want to cache the error response. When this time period has elapsed, CloudFront queries your origin to see whether the problem that caused the error has been resolved and the requested object is now available."
@@ -901,7 +912,11 @@ var SitesSchema = z29.record(
     // ]),
     geoRestrictions: z29.array(z29.string().length(2).toUpperCase()).default([]).describe("Specifies a blacklist of countries that should be blocked."),
     forwardHost: z29.boolean().default(false).describe(
-      "Specify if the host header should be forwarded to the SSR function. Keep in mind that this requires an extra CloudFront Function."
+      [
+        "Specify if the original `host` header should be forwarded to the SSR function.",
+        "The original `host` header will be forwarded as `x-forwarded-host`.",
+        "Keep in mind that this requires an extra CloudFront Function."
+      ].join("\n")
     ),
     errors: z29.object({
       400: ErrorResponseSchema.describe("Customize a `400 Bad Request` response."),
@@ -924,7 +939,7 @@ var SitesSchema = z29.record(
       headers: z29.string().array().default(["*"]),
       origins: z29.string().array().default(["*"]),
       methods: z29.enum(["GET", "DELETE", "HEAD", "OPTIONS", "PATCH", "POST", "PUT", "ALL"]).array().default(["ALL"])
-    }).optional().describe("Define the cors headers."),
+    }).optional().describe("Specify the cors headers."),
     security: z29.object({
       // contentSecurityPolicy: z.object({
       // 	override: z.boolean().default(false),
@@ -966,7 +981,7 @@ var SitesSchema = z29.record(
       // 	modeBlock?: boolean
       // 	reportUri?: string
       // }
-    }).optional().describe("Define the security policy."),
+    }).optional().describe("Specify the security policy."),
     cache: z29.object({
       cookies: z29.string().array().optional().describe("Specifies the cookies that CloudFront includes in the cache key."),
       headers: z29.string().array().optional().describe("Specifies the headers that CloudFront includes in the cache key."),