Make empty methods optional, add examples typechecking

openapi-ts · Oct 5, 2023 · bbd21db · bbd21db
1 parent 04a024a
commit bbd21db
Show file tree

Hide file tree

Showing 29 changed files with 14,200 additions and 14,064 deletions.
diff --git a/.changeset/beige-ligers-tell.md b/.changeset/beige-ligers-tell.md
diff --git a/.changeset/rich-poems-swim.md b/.changeset/rich-poems-swim.md
diff --git a/packages/openapi-fetch/examples/nextjs/lib/api/v1.d.ts b/packages/openapi-fetch/examples/nextjs/lib/api/v1.d.ts
@@ -16,13 +16,13 @@ export interface paths {
          * @description Returns a a list of breeds
          */
         get: operations["getBreeds"];
-        put: never;
-        post: never;
-        delete: never;
-        options: never;
-        head: never;
-        patch: never;
-        trace: never;
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
     };
     "/fact": {
         parameters: {
@@ -36,13 +36,13 @@ export interface paths {
          * @description Returns a random fact
          */
         get: operations["getRandomFact"];
-        put: never;
-        post: never;
-        delete: never;
-        options: never;
-        head: never;
-        patch: never;
-        trace: never;
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
     };
     "/facts": {
         parameters: {
@@ -56,13 +56,13 @@ export interface paths {
          * @description Returns a a list of facts
          */
         get: operations["getFacts"];
-        put: never;
-        post: never;
-        delete: never;
-        options: never;
-        head: never;
-        patch: never;
-        trace: never;
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
     };
 }
 export type webhooks = Record<string, never>;

diff --git a/packages/openapi-fetch/examples/react-query/src/lib/api/v1.d.ts b/packages/openapi-fetch/examples/react-query/src/lib/api/v1.d.ts
@@ -16,13 +16,13 @@ export interface paths {
          * @description Returns a a list of breeds
          */
         get: operations["getBreeds"];
-        put: never;
-        post: never;
-        delete: never;
-        options: never;
-        head: never;
-        patch: never;
-        trace: never;
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
     };
     "/fact": {
         parameters: {
@@ -36,13 +36,13 @@ export interface paths {
          * @description Returns a random fact
          */
         get: operations["getRandomFact"];
-        put: never;
-        post: never;
-        delete: never;
-        options: never;
-        head: never;
-        patch: never;
-        trace: never;
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
     };
     "/facts": {
         parameters: {
@@ -56,13 +56,13 @@ export interface paths {
          * @description Returns a a list of facts
          */
         get: operations["getFacts"];
-        put: never;
-        post: never;
-        delete: never;
-        options: never;
-        head: never;
-        patch: never;
-        trace: never;
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
     };
 }
 export type webhooks = Record<string, never>;

diff --git a/packages/openapi-fetch/examples/sveltekit/src/lib/api/v1.d.ts b/packages/openapi-fetch/examples/sveltekit/src/lib/api/v1.d.ts
@@ -16,13 +16,13 @@ export interface paths {
          * @description Returns a a list of breeds
          */
         get: operations["getBreeds"];
-        put: never;
-        post: never;
-        delete: never;
-        options: never;
-        head: never;
-        patch: never;
-        trace: never;
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
     };
     "/fact": {
         parameters: {
@@ -36,13 +36,13 @@ export interface paths {
          * @description Returns a random fact
          */
         get: operations["getRandomFact"];
-        put: never;
-        post: never;
-        delete: never;
-        options: never;
-        head: never;
-        patch: never;
-        trace: never;
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
     };
     "/facts": {
         parameters: {
@@ -56,13 +56,13 @@ export interface paths {
          * @description Returns a a list of facts
          */
         get: operations["getFacts"];
-        put: never;
-        post: never;
-        delete: never;
-        options: never;
-        head: never;
-        patch: never;
-        trace: never;
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
     };
 }
 export type webhooks = Record<string, never>;

diff --git a/packages/openapi-fetch/src/index.ts b/packages/openapi-fetch/src/index.ts
@@ -59,10 +59,10 @@ export interface EmptyParameters {
 }
 
 export type ParamsOption<T> = T extends { parameters: any }
-  ? T["parameters"] extends EmptyParameters
-    ? DefaultParamsOption
-    : { params: NonNullable<T["parameters"]> }
-  : DefaultParamsOption;
+  ? HasRequiredKeys<T["parameters"]> extends never
+    ? { params?: T["parameters"] }
+    : { params: T["parameters"] }
+  : never;
 
 export type RequestBodyOption<T> = OperationRequestBodyContent<T> extends never
   ? { body?: never }