@scalar/api-client - npm Package Compare versions

Comparing version 0.8.0 to 0.8.1

CHANGELOG.md

 # @scalar/api-client
 
+## 0.8.1
+
+### Patch Changes
+
+- f87910d: feat: prefill path, header, cookie, query parameters from the spec
+
 ## 0.8.0
@@ -4,0 +10,0 @@

dist/helpers/prepareClientRequestConfig.d.ts

@@ -11,3 +11,3 @@ import type { AuthState, ClientRequestConfig } from '../types';
     path: string;
-    parameters?: import("../types").BaseParameter[] | undefined;
+    variables?: import("../types").BaseParameter[] | undefined;
     query?: import("../types").BaseParameter[] | undefined;
@@ -14,0 +14,0 @@ cookies?: import("../types").BaseParameter[] | undefined;

dist/stores/requestStore.d.ts

@@ -39,21 +39,29 @@ import type { AuthState, ClientRequestConfig, RequestResult } from '../types';
         path: string;
-        parameters?: {
+        variables?: {
             name: string;
+            description?: string | null | undefined;
             value: string | number;
             customClass?: string | undefined;
+            required?: boolean | undefined;
         }[] | undefined;
         query?: {
             name: string;
+            description?: string | null | undefined;
             value: string | number;
             customClass?: string | undefined;
+            required?: boolean | undefined;
         }[] | undefined;
         cookies?: {
             name: string;
+            description?: string | null | undefined;
             value: string | number;
             customClass?: string | undefined;
+            required?: boolean | undefined;
         }[] | undefined;
         headers?: {
             name: string;
+            description?: string | null | undefined;
             value: string | number;
             customClass?: string | undefined;
+            required?: boolean | undefined;
         }[] | undefined;
@@ -63,4 +71,6 @@ body?: string | undefined;
             name: string;
+            description?: string | null | undefined;
             value: string | number;
             customClass?: string | undefined;
+            required?: boolean | undefined;
         }[] | undefined;
@@ -67,0 +77,0 @@ };

dist/types.d.ts

@@ -35,4 +35,6 @@ export type BasicAuth = {
     name: string;
+    description?: string | null;
     value: string | number;
     customClass?: string;
+    required?: boolean;
 };
@@ -52,5 +54,4 @@ export type Header = BaseParameter;
     path: string;
-    /** TODO: Rename to variables? */
-    /** Path parameters */
-    parameters?: BaseParameter[];
+    /** Variables */
+    variables?: BaseParameter[];
     /** Query parameters */
@@ -57,0 +58,0 @@ query?: Query[];

package.json

@@ -16,3 +16,3 @@ {
   ],
-  "version": "0.8.0",
+  "version": "0.8.1",
   "engines": {
@@ -19,0 +19,0 @@ "node": ">=20"

No alert changes

Improved metrics

Total package byte prevSize

1232846

increased by0.09%

Lines of code

29990

increased by0.08%

No dependency changes