@tetsujs/openapi 0.5.2 → 0.6.0

package/src/testing.ts

@@ -59,6 +59,9 @@ export interface AssertDescribedOptions {
    * Headers the status must declare when the response carries them —
    * `retry-after`. Only those named: a response carries headers no
    * document describes, `content-type` and `x-request-id` among them.
+   *
+   * The other way needs no list: a header the status declares required —
+   * a `location`, a `set-cookie` — is one the response must carry.
    */
   readonly headers?: readonly string[];
 }
@@ -124,8 +127,10 @@ async function problemsOf(
  * The path template a requested path belongs to: the one whose segments
  * match it, `{param}` matching any one segment. Of several, the one with
  * the most literal segments, as the router prefers `/users/me` to
- * `/users/{id}`; a template ending in a parameter also stands for a
- * wildcard, which matches the rest of the path.
+ * `/users/{id}`. A template ending in `{wildcard}` — the name the
+ * generator gives a trailing `*` — matches the rest of the path; any other
+ * matches as many segments as it has, so a mistyped path is no operation
+ * rather than the one it happens to start like.
  */
 function templateOf(
   document: OpenApiDocument,
@@ -138,7 +143,7 @@ function templateOf(
   for (const template of Object.keys(document.paths)) {
     const parts = template.split("/").filter(Boolean);
     const last = parts.at(-1) ?? "";
-    const rest = isParameter(last) && segments.length > parts.length;
+    const rest = last === "{wildcard}" && segments.length > parts.length;
 
     if (parts.length !== segments.length && !rest) {
       continue;
@@ -185,7 +190,11 @@ async function bodyProblems(
   const mediaTypes = Object.keys(content);
 
   if (text === "") {
-    return [];
+    return mediaTypes.length === 0
+      ? []
+      : [
+          `an empty body, where its ${status} describes ${mediaTypes.join(", ")}`,
+        ];
   }
 
   if (mediaTypes.length === 0) {
@@ -421,7 +430,7 @@ function headerProblems(
     name.toLowerCase(),
   );
 
-  return names
+  const undeclared = names
     .filter(
       (name) =>
         response.headers.has(name) && !declared.includes(name.toLowerCase()),
@@ -429,6 +438,12 @@ function headerProblems(
     .map(
       (name) => `the header "${name}", which its ${status} does not declare`,
     );
+
+  const missing = Object.entries(described.headers ?? {})
+    .filter(([name, header]) => header.required && !response.headers.has(name))
+    .map(([name]) => `no header "${name}", which its ${status} requires`);
+
+  return [...undeclared, ...missing];
 }
 
 /**