@scalar/workspace-store 0.5.2 → 0.7.0

package/dist/server.d.ts

@@ -1,15 +1,27 @@
 import type { WorkspaceDocumentMeta, WorkspaceMeta } from './schemas/workspace.js';
 import { type createNavigationOptions } from './navigation/index.js';
+import { extensions } from './schemas/extensions.js';
 import { type OpenApiDocument } from './schemas/v3.1/strict/openapi-document.js';
 import type { PathsObject } from './schemas/v3.1/strict/paths.js';
 import type { OperationObject } from './schemas/v3.1/strict/path-operations.js';
+import type { TraversedEntry } from './navigation/types.js';
 export declare const WORKSPACE_FILE_NAME = "scalar-workspace.json";
+type WorkspaceDocumentMetaInput = {
+    name: string;
+    meta?: WorkspaceDocumentMeta;
+};
+type UrlDoc = {
+    url: string;
+} & WorkspaceDocumentMetaInput;
+type FileDoc = {
+    path: string;
+} & WorkspaceDocumentMetaInput;
+type ObjectDoc = {
+    document: Record<string, unknown>;
+} & WorkspaceDocumentMetaInput;
+type WorkspaceDocumentInput = UrlDoc | ObjectDoc | FileDoc;
 type CreateServerWorkspaceStoreBase = {
-    documents: {
-        name: string;
-        document: Record<string, unknown> | string;
-        meta?: WorkspaceDocumentMeta;
-    }[];
+    documents: WorkspaceDocumentInput[];
     meta?: WorkspaceMeta;
     config?: createNavigationOptions;
 };
@@ -68,10 +80,29 @@ export declare function filterHttpMethodsOnly(paths: PathsObject): Record<string
         deprecated?: boolean | undefined;
         allowEmptyValue?: boolean | undefined;
         name: string;
-        in: string;
+        in: "query" | "header" | "path" | "cookie";
     } & {
         [x: `x-${string}`]: unknown;
     } & {
+        examples?: {
+            [x: string]: ({
+                summary?: string | undefined;
+                description?: string | undefined;
+                $ref: string;
+            } & {
+                $status?: "loading" | "error" | undefined;
+                $global?: boolean | undefined;
+            } & {
+                [x: `x-${string}`]: unknown;
+            }) | ({
+                summary?: string | undefined;
+                description?: string | undefined;
+                value?: any;
+                externalValue?: string | undefined;
+            } & {
+                [x: `x-${string}`]: unknown;
+            });
+        } | undefined;
         style?: string | undefined;
         explode?: boolean | undefined;
         schema?: ({
@@ -108,6 +139,7 @@ export declare function filterHttpMethodsOnly(paths: PathsObject): Record<string
                 [x: `x-${string}`]: unknown;
             }) | undefined;
             example?: any;
+            examples?: unknown[] | undefined;
         } & {
             [x: `x-${string}`]: unknown;
         } & {
@@ -115,25 +147,6 @@ export declare function filterHttpMethodsOnly(paths: PathsObject): Record<string
         } & {
             [x: string]: unknown;
         }) | undefined;
-        examples?: {
-            [x: string]: ({
-                summary?: string | undefined;
-                description?: string | undefined;
-                $ref: string;
-            } & {
-                $status?: "loading" | "error" | undefined;
-                $global?: boolean | undefined;
-            } & {
-                [x: `x-${string}`]: unknown;
-            }) | ({
-                summary?: string | undefined;
-                description?: string | undefined;
-                value?: any;
-                externalValue?: string | undefined;
-            } & {
-                [x: `x-${string}`]: unknown;
-            });
-        } | undefined;
         example: any;
     }) | ({
         description?: string | undefined;
@@ -141,13 +154,32 @@ export declare function filterHttpMethodsOnly(paths: PathsObject): Record<string
         deprecated?: boolean | undefined;
         allowEmptyValue?: boolean | undefined;
         name: string;
-        in: string;
+        in: "query" | "header" | "path" | "cookie";
     } & {
         [x: `x-${string}`]: unknown;
     } & {
         content?: {
             [x: string]: {
                 example?: any;
+                examples?: {
+                    [x: string]: ({
+                        summary?: string | undefined;
+                        description?: string | undefined;
+                        value?: any;
+                        externalValue?: string | undefined;
+                    } & {
+                        [x: `x-${string}`]: unknown;
+                    }) | ({
+                        summary?: string | undefined;
+                        description?: string | undefined;
+                        $ref: string;
+                    } & {
+                        $status?: "loading" | "error" | undefined;
+                        $global?: boolean | undefined;
+                    } & {
+                        [x: `x-${string}`]: unknown;
+                    });
+                } | undefined;
                 schema?: ({
                     discriminator?: ({
                         mapping?: {
@@ -173,6 +205,7 @@ export declare function filterHttpMethodsOnly(paths: PathsObject): Record<string
                         [x: `x-${string}`]: unknown;
                     }) | undefined;
                     example?: any;
+                    examples?: unknown[] | undefined;
                 } & {
                     [x: `x-${string}`]: unknown;
                 } & {
@@ -180,25 +213,6 @@ export declare function filterHttpMethodsOnly(paths: PathsObject): Record<string
                 } & {
                     [x: string]: unknown;
                 }) | undefined;
-                examples?: {
-                    [x: string]: ({
-                        summary?: string | undefined;
-                        description?: string | undefined;
-                        value?: any;
-                        externalValue?: string | undefined;
-                    } & {
-                        [x: `x-${string}`]: unknown;
-                    }) | ({
-                        summary?: string | undefined;
-                        description?: string | undefined;
-                        $ref: string;
-                    } & {
-                        $status?: "loading" | "error" | undefined;
-                        $global?: boolean | undefined;
-                    } & {
-                        [x: `x-${string}`]: unknown;
-                    });
-                } | undefined;
                 encoding?: {
                     [x: string]: {
                         contentType?: string | undefined;
@@ -219,9 +233,37 @@ export declare function filterHttpMethodsOnly(paths: PathsObject): Record<string
                             } & {
                                 [x: `x-${string}`]: unknown;
                             } & {
+                                examples?: {
+                                    [x: string]: ({
+                                        summary?: string | undefined;
+                                        description?: string | undefined;
+                                        value?: any;
+                                        externalValue?: string | undefined;
+                                    } & {
+                                        [x: `x-${string}`]: unknown;
+                                    }) | ({
+                                        summary?: string | undefined;
+                                        description?: string | undefined;
+                                        $ref: string;
+                                    } & {
+                                        $status?: "loading" | "error" | undefined;
+                                        $global?: boolean | undefined;
+                                    } & {
+                                        [x: `x-${string}`]: unknown;
+                                    });
+                                } | undefined;
                                 style?: string | undefined;
                                 explode?: boolean | undefined;
                                 schema?: ({
+                                    summary?: string | undefined;
+                                    description?: string | undefined;
+                                    $ref: string;
+                                } & {
+                                    $status?: "loading" | "error" | undefined;
+                                    $global?: boolean | undefined;
+                                } & {
+                                    [x: `x-${string}`]: unknown;
+                                }) | ({
                                     discriminator?: ({
                                         mapping?: {
                                             [x: string]: string;
@@ -246,41 +288,14 @@ export declare function filterHttpMethodsOnly(paths: PathsObject): Record<string
                                         [x: `x-${string}`]: unknown;
                                     }) | undefined;
                                     example?: any;
+                                    examples?: unknown[] | undefined;
                                 } & {
                                     [x: `x-${string}`]: unknown;
                                 } & {
                                     'x-tags'?: string[] | undefined;
                                 } & {
                                     [x: string]: unknown;
-                                }) | ({
-                                    summary?: string | undefined;
-                                    description?: string | undefined;
-                                    $ref: string;
-                                } & {
-                                    $status?: "loading" | "error" | undefined;
-                                    $global?: boolean | undefined;
-                                } & {
-                                    [x: `x-${string}`]: unknown;
                                 }) | undefined;
-                                examples?: {
-                                    [x: string]: ({
-                                        summary?: string | undefined;
-                                        description?: string | undefined;
-                                        value?: any;
-                                        externalValue?: string | undefined;
-                                    } & {
-                                        [x: `x-${string}`]: unknown;
-                                    }) | ({
-                                        summary?: string | undefined;
-                                        description?: string | undefined;
-                                        $ref: string;
-                                    } & {
-                                        $status?: "loading" | "error" | undefined;
-                                        $global?: boolean | undefined;
-                                    } & {
-                                        [x: `x-${string}`]: unknown;
-                                    });
-                                } | undefined;
                                 example: any;
                             }) | ({
                                 description?: string | undefined;
@@ -320,6 +335,25 @@ export declare function filterHttpMethodsOnly(paths: PathsObject): Record<string
         content: {
             [x: string]: {
                 example?: any;
+                examples?: {
+                    [x: string]: ({
+                        summary?: string | undefined;
+                        description?: string | undefined;
+                        value?: any;
+                        externalValue?: string | undefined;
+                    } & {
+                        [x: `x-${string}`]: unknown;
+                    }) | ({
+                        summary?: string | undefined;
+                        description?: string | undefined;
+                        $ref: string;
+                    } & {
+                        $status?: "loading" | "error" | undefined;
+                        $global?: boolean | undefined;
+                    } & {
+                        [x: `x-${string}`]: unknown;
+                    });
+                } | undefined;
                 schema?: ({
                     discriminator?: ({
                         mapping?: {
@@ -345,6 +379,7 @@ export declare function filterHttpMethodsOnly(paths: PathsObject): Record<string
                         [x: `x-${string}`]: unknown;
                     }) | undefined;
                     example?: any;
+                    examples?: unknown[] | undefined;
                 } & {
                     [x: `x-${string}`]: unknown;
                 } & {
@@ -352,25 +387,6 @@ export declare function filterHttpMethodsOnly(paths: PathsObject): Record<string
                 } & {
                     [x: string]: unknown;
                 }) | undefined;
-                examples?: {
-                    [x: string]: ({
-                        summary?: string | undefined;
-                        description?: string | undefined;
-                        value?: any;
-                        externalValue?: string | undefined;
-                    } & {
-                        [x: `x-${string}`]: unknown;
-                    }) | ({
-                        summary?: string | undefined;
-                        description?: string | undefined;
-                        $ref: string;
-                    } & {
-                        $status?: "loading" | "error" | undefined;
-                        $global?: boolean | undefined;
-                    } & {
-                        [x: `x-${string}`]: unknown;
-                    });
-                } | undefined;
                 encoding?: {
                     [x: string]: {
                         contentType?: string | undefined;
@@ -391,9 +407,37 @@ export declare function filterHttpMethodsOnly(paths: PathsObject): Record<string
                             } & {
                                 [x: `x-${string}`]: unknown;
                             } & {
+                                examples?: {
+                                    [x: string]: ({
+                                        summary?: string | undefined;
+                                        description?: string | undefined;
+                                        value?: any;
+                                        externalValue?: string | undefined;
+                                    } & {
+                                        [x: `x-${string}`]: unknown;
+                                    }) | ({
+                                        summary?: string | undefined;
+                                        description?: string | undefined;
+                                        $ref: string;
+                                    } & {
+                                        $status?: "loading" | "error" | undefined;
+                                        $global?: boolean | undefined;
+                                    } & {
+                                        [x: `x-${string}`]: unknown;
+                                    });
+                                } | undefined;
                                 style?: string | undefined;
                                 explode?: boolean | undefined;
                                 schema?: ({
+                                    summary?: string | undefined;
+                                    description?: string | undefined;
+                                    $ref: string;
+                                } & {
+                                    $status?: "loading" | "error" | undefined;
+                                    $global?: boolean | undefined;
+                                } & {
+                                    [x: `x-${string}`]: unknown;
+                                }) | ({
                                     discriminator?: ({
                                         mapping?: {
                                             [x: string]: string;
@@ -418,41 +462,14 @@ export declare function filterHttpMethodsOnly(paths: PathsObject): Record<string
                                         [x: `x-${string}`]: unknown;
                                     }) | undefined;
                                     example?: any;
+                                    examples?: unknown[] | undefined;
                                 } & {
                                     [x: `x-${string}`]: unknown;
                                 } & {
                                     'x-tags'?: string[] | undefined;
                                 } & {
                                     [x: string]: unknown;
-                                }) | ({
-                                    summary?: string | undefined;
-                                    description?: string | undefined;
-                                    $ref: string;
-                                } & {
-                                    $status?: "loading" | "error" | undefined;
-                                    $global?: boolean | undefined;
-                                } & {
-                                    [x: `x-${string}`]: unknown;
                                 }) | undefined;
-                                examples?: {
-                                    [x: string]: ({
-                                        summary?: string | undefined;
-                                        description?: string | undefined;
-                                        value?: any;
-                                        externalValue?: string | undefined;
-                                    } & {
-                                        [x: `x-${string}`]: unknown;
-                                    }) | ({
-                                        summary?: string | undefined;
-                                        description?: string | undefined;
-                                        $ref: string;
-                                    } & {
-                                        $status?: "loading" | "error" | undefined;
-                                        $global?: boolean | undefined;
-                                    } & {
-                                        [x: `x-${string}`]: unknown;
-                                    });
-                                } | undefined;
                                 example: any;
                             }) | ({
                                 description?: string | undefined;
@@ -499,40 +516,28 @@ export declare function filterHttpMethodsOnly(paths: PathsObject): Record<string
                 } & {
                     [x: `x-${string}`]: unknown;
                 } & {
-                    style?: string | undefined;
-                    explode?: boolean | undefined;
-                    schema?: ({
-                        discriminator?: ({
-                            mapping?: {
-                                [x: string]: string;
-                            } | undefined;
-                            propertyName: string;
-                        } & {
-                            [x: `x-${string}`]: unknown;
-                        }) | undefined;
-                        xml?: ({
-                            name?: string | undefined;
-                            namespace?: string | undefined;
-                            prefix?: string | undefined;
-                            attribute?: boolean | undefined;
-                            wrapped?: boolean | undefined;
-                        } & {
-                            [x: `x-${string}`]: unknown;
-                        }) | undefined;
-                        externalDocs?: ({
+                    examples?: {
+                        [x: string]: ({
+                            summary?: string | undefined;
                             description?: string | undefined;
-                            url: string;
+                            value?: any;
+                            externalValue?: string | undefined;
                         } & {
                             [x: `x-${string}`]: unknown;
-                        }) | undefined;
-                        example?: any;
-                    } & {
-                        [x: `x-${string}`]: unknown;
-                    } & {
-                        'x-tags'?: string[] | undefined;
-                    } & {
-                        [x: string]: unknown;
-                    }) | ({
+                        }) | ({
+                            summary?: string | undefined;
+                            description?: string | undefined;
+                            $ref: string;
+                        } & {
+                            $status?: "loading" | "error" | undefined;
+                            $global?: boolean | undefined;
+                        } & {
+                            [x: `x-${string}`]: unknown;
+                        });
+                    } | undefined;
+                    style?: string | undefined;
+                    explode?: boolean | undefined;
+                    schema?: ({
                         summary?: string | undefined;
                         description?: string | undefined;
                         $ref: string;
@@ -541,26 +546,39 @@ export declare function filterHttpMethodsOnly(paths: PathsObject): Record<string
                         $global?: boolean | undefined;
                     } & {
                         [x: `x-${string}`]: unknown;
-                    }) | undefined;
-                    examples?: {
-                        [x: string]: ({
-                            summary?: string | undefined;
-                            description?: string | undefined;
-                            $ref: string;
+                    }) | ({
+                        discriminator?: ({
+                            mapping?: {
+                                [x: string]: string;
+                            } | undefined;
+                            propertyName: string;
                         } & {
-                            $status?: "loading" | "error" | undefined;
-                            $global?: boolean | undefined;
+                            [x: `x-${string}`]: unknown;
+                        }) | undefined;
+                        xml?: ({
+                            name?: string | undefined;
+                            namespace?: string | undefined;
+                            prefix?: string | undefined;
+                            attribute?: boolean | undefined;
+                            wrapped?: boolean | undefined;
                         } & {
                             [x: `x-${string}`]: unknown;
-                        }) | ({
-                            summary?: string | undefined;
+                        }) | undefined;
+                        externalDocs?: ({
                             description?: string | undefined;
-                            value?: any;
-                            externalValue?: string | undefined;
+                            url: string;
                         } & {
                             [x: `x-${string}`]: unknown;
-                        });
-                    } | undefined;
+                        }) | undefined;
+                        example?: any;
+                        examples?: unknown[] | undefined;
+                    } & {
+                        [x: `x-${string}`]: unknown;
+                    } & {
+                        'x-tags'?: string[] | undefined;
+                    } & {
+                        [x: string]: unknown;
+                    }) | undefined;
                     example: any;
                 }) | ({
                     description?: string | undefined;
@@ -572,6 +590,25 @@ export declare function filterHttpMethodsOnly(paths: PathsObject): Record<string
                     content?: {
                         [x: string]: {
                             example?: any;
+                            examples?: {
+                                [x: string]: ({
+                                    summary?: string | undefined;
+                                    description?: string | undefined;
+                                    value?: any;
+                                    externalValue?: string | undefined;
+                                } & {
+                                    [x: `x-${string}`]: unknown;
+                                }) | ({
+                                    summary?: string | undefined;
+                                    description?: string | undefined;
+                                    $ref: string;
+                                } & {
+                                    $status?: "loading" | "error" | undefined;
+                                    $global?: boolean | undefined;
+                                } & {
+                                    [x: `x-${string}`]: unknown;
+                                });
+                            } | undefined;
                             schema?: ({
                                 discriminator?: ({
                                     mapping?: {
@@ -597,6 +634,7 @@ export declare function filterHttpMethodsOnly(paths: PathsObject): Record<string
                                     [x: `x-${string}`]: unknown;
                                 }) | undefined;
                                 example?: any;
+                                examples?: unknown[] | undefined;
                             } & {
                                 [x: `x-${string}`]: unknown;
                             } & {
@@ -604,25 +642,6 @@ export declare function filterHttpMethodsOnly(paths: PathsObject): Record<string
                             } & {
                                 [x: string]: unknown;
                             }) | undefined;
-                            examples?: {
-                                [x: string]: ({
-                                    summary?: string | undefined;
-                                    description?: string | undefined;
-                                    $ref: string;
-                                } & {
-                                    $status?: "loading" | "error" | undefined;
-                                    $global?: boolean | undefined;
-                                } & {
-                                    [x: `x-${string}`]: unknown;
-                                }) | ({
-                                    summary?: string | undefined;
-                                    description?: string | undefined;
-                                    value?: any;
-                                    externalValue?: string | undefined;
-                                } & {
-                                    [x: `x-${string}`]: unknown;
-                                });
-                            } | undefined;
                             encoding?: {
                                 [x: string]: {
                                     contentType?: string | undefined;
@@ -634,9 +653,37 @@ export declare function filterHttpMethodsOnly(paths: PathsObject): Record<string
                                         } & {
                                             [x: `x-${string}`]: unknown;
                                         } & {
+                                            examples?: {
+                                                [x: string]: ({
+                                                    summary?: string | undefined;
+                                                    description?: string | undefined;
+                                                    value?: any;
+                                                    externalValue?: string | undefined;
+                                                } & {
+                                                    [x: `x-${string}`]: unknown;
+                                                }) | ({
+                                                    summary?: string | undefined;
+                                                    description?: string | undefined;
+                                                    $ref: string;
+                                                } & {
+                                                    $status?: "loading" | "error" | undefined;
+                                                    $global?: boolean | undefined;
+                                                } & {
+                                                    [x: `x-${string}`]: unknown;
+                                                });
+                                            } | undefined;
                                             style?: string | undefined;
                                             explode?: boolean | undefined;
                                             schema?: ({
+                                                summary?: string | undefined;
+                                                description?: string | undefined;
+                                                $ref: string;
+                                            } & {
+                                                $status?: "loading" | "error" | undefined;
+                                                $global?: boolean | undefined;
+                                            } & {
+                                                [x: `x-${string}`]: unknown;
+                                            }) | ({
                                                 discriminator?: ({
                                                     mapping?: {
                                                         [x: string]: string;
@@ -661,41 +708,14 @@ export declare function filterHttpMethodsOnly(paths: PathsObject): Record<string
                                                     [x: `x-${string}`]: unknown;
                                                 }) | undefined;
                                                 example?: any;
+                                                examples?: unknown[] | undefined;
                                             } & {
                                                 [x: `x-${string}`]: unknown;
                                             } & {
                                                 'x-tags'?: string[] | undefined;
                                             } & {
                                                 [x: string]: unknown;
-                                            }) | ({
-                                                summary?: string | undefined;
-                                                description?: string | undefined;
-                                                $ref: string;
-                                            } & {
-                                                $status?: "loading" | "error" | undefined;
-                                                $global?: boolean | undefined;
-                                            } & {
-                                                [x: `x-${string}`]: unknown;
                                             }) | undefined;
-                                            examples?: {
-                                                [x: string]: ({
-                                                    summary?: string | undefined;
-                                                    description?: string | undefined;
-                                                    $ref: string;
-                                                } & {
-                                                    $status?: "loading" | "error" | undefined;
-                                                    $global?: boolean | undefined;
-                                                } & {
-                                                    [x: `x-${string}`]: unknown;
-                                                }) | ({
-                                                    summary?: string | undefined;
-                                                    description?: string | undefined;
-                                                    value?: any;
-                                                    externalValue?: string | undefined;
-                                                } & {
-                                                    [x: `x-${string}`]: unknown;
-                                                });
-                                            } | undefined;
                                             example: any;
                                         }) | ({
                                             description?: string | undefined;
@@ -736,6 +756,25 @@ export declare function filterHttpMethodsOnly(paths: PathsObject): Record<string
             content?: {
                 [x: string]: {
                     example?: any;
+                    examples?: {
+                        [x: string]: ({
+                            summary?: string | undefined;
+                            description?: string | undefined;
+                            value?: any;
+                            externalValue?: string | undefined;
+                        } & {
+                            [x: `x-${string}`]: unknown;
+                        }) | ({
+                            summary?: string | undefined;
+                            description?: string | undefined;
+                            $ref: string;
+                        } & {
+                            $status?: "loading" | "error" | undefined;
+                            $global?: boolean | undefined;
+                        } & {
+                            [x: `x-${string}`]: unknown;
+                        });
+                    } | undefined;
                     schema?: ({
                         discriminator?: ({
                             mapping?: {
@@ -761,6 +800,7 @@ export declare function filterHttpMethodsOnly(paths: PathsObject): Record<string
                             [x: `x-${string}`]: unknown;
                         }) | undefined;
                         example?: any;
+                        examples?: unknown[] | undefined;
                     } & {
                         [x: `x-${string}`]: unknown;
                     } & {
@@ -768,25 +808,6 @@ export declare function filterHttpMethodsOnly(paths: PathsObject): Record<string
                     } & {
                         [x: string]: unknown;
                     }) | undefined;
-                    examples?: {
-                        [x: string]: ({
-                            summary?: string | undefined;
-                            description?: string | undefined;
-                            value?: any;
-                            externalValue?: string | undefined;
-                        } & {
-                            [x: `x-${string}`]: unknown;
-                        }) | ({
-                            summary?: string | undefined;
-                            description?: string | undefined;
-                            $ref: string;
-                        } & {
-                            $status?: "loading" | "error" | undefined;
-                            $global?: boolean | undefined;
-                        } & {
-                            [x: `x-${string}`]: unknown;
-                        });
-                    } | undefined;
                     encoding?: {
                         [x: string]: {
                             contentType?: string | undefined;
@@ -807,9 +828,37 @@ export declare function filterHttpMethodsOnly(paths: PathsObject): Record<string
                                 } & {
                                     [x: `x-${string}`]: unknown;
                                 } & {
+                                    examples?: {
+                                        [x: string]: ({
+                                            summary?: string | undefined;
+                                            description?: string | undefined;
+                                            value?: any;
+                                            externalValue?: string | undefined;
+                                        } & {
+                                            [x: `x-${string}`]: unknown;
+                                        }) | ({
+                                            summary?: string | undefined;
+                                            description?: string | undefined;
+                                            $ref: string;
+                                        } & {
+                                            $status?: "loading" | "error" | undefined;
+                                            $global?: boolean | undefined;
+                                        } & {
+                                            [x: `x-${string}`]: unknown;
+                                        });
+                                    } | undefined;
                                     style?: string | undefined;
                                     explode?: boolean | undefined;
                                     schema?: ({
+                                        summary?: string | undefined;
+                                        description?: string | undefined;
+                                        $ref: string;
+                                    } & {
+                                        $status?: "loading" | "error" | undefined;
+                                        $global?: boolean | undefined;
+                                    } & {
+                                        [x: `x-${string}`]: unknown;
+                                    }) | ({
                                         discriminator?: ({
                                             mapping?: {
                                                 [x: string]: string;
@@ -834,41 +883,14 @@ export declare function filterHttpMethodsOnly(paths: PathsObject): Record<string
                                             [x: `x-${string}`]: unknown;
                                         }) | undefined;
                                         example?: any;
+                                        examples?: unknown[] | undefined;
                                     } & {
                                         [x: `x-${string}`]: unknown;
                                     } & {
                                         'x-tags'?: string[] | undefined;
                                     } & {
                                         [x: string]: unknown;
-                                    }) | ({
-                                        summary?: string | undefined;
-                                        description?: string | undefined;
-                                        $ref: string;
-                                    } & {
-                                        $status?: "loading" | "error" | undefined;
-                                        $global?: boolean | undefined;
-                                    } & {
-                                        [x: `x-${string}`]: unknown;
                                     }) | undefined;
-                                    examples?: {
-                                        [x: string]: ({
-                                            summary?: string | undefined;
-                                            description?: string | undefined;
-                                            value?: any;
-                                            externalValue?: string | undefined;
-                                        } & {
-                                            [x: `x-${string}`]: unknown;
-                                        }) | ({
-                                            summary?: string | undefined;
-                                            description?: string | undefined;
-                                            $ref: string;
-                                        } & {
-                                            $status?: "loading" | "error" | undefined;
-                                            $global?: boolean | undefined;
-                                        } & {
-                                            [x: `x-${string}`]: unknown;
-                                        });
-                                    } | undefined;
                                     example: any;
                                 }) | ({
                                     description?: string | undefined;
@@ -986,15 +1008,34 @@ export declare function filterHttpMethodsOnly(paths: PathsObject): Record<string
                     deprecated?: boolean | undefined;
                     allowEmptyValue?: boolean | undefined;
                     name: string;
-                    in: string;
+                    in: "query" | "header" | "path" | "cookie";
                 } & {
                     [x: `x-${string}`]: unknown;
                 } & {
-                    style?: string | undefined;
-                    explode?: boolean | undefined;
-                    schema?: ({
-                        summary?: string | undefined;
-                        description?: string | undefined;
+                    examples?: {
+                        [x: string]: ({
+                            summary?: string | undefined;
+                            description?: string | undefined;
+                            $ref: string;
+                        } & {
+                            $status?: "loading" | "error" | undefined;
+                            $global?: boolean | undefined;
+                        } & {
+                            [x: `x-${string}`]: unknown;
+                        }) | ({
+                            summary?: string | undefined;
+                            description?: string | undefined;
+                            value?: any;
+                            externalValue?: string | undefined;
+                        } & {
+                            [x: `x-${string}`]: unknown;
+                        });
+                    } | undefined;
+                    style?: string | undefined;
+                    explode?: boolean | undefined;
+                    schema?: ({
+                        summary?: string | undefined;
+                        description?: string | undefined;
                         $ref: string;
                     } & {
                         $status?: "loading" | "error" | undefined;
@@ -1026,6 +1067,7 @@ export declare function filterHttpMethodsOnly(paths: PathsObject): Record<string
                             [x: `x-${string}`]: unknown;
                         }) | undefined;
                         example?: any;
+                        examples?: unknown[] | undefined;
                     } & {
                         [x: `x-${string}`]: unknown;
                     } & {
@@ -1033,25 +1075,6 @@ export declare function filterHttpMethodsOnly(paths: PathsObject): Record<string
                     } & {
                         [x: string]: unknown;
                     }) | undefined;
-                    examples?: {
-                        [x: string]: ({
-                            summary?: string | undefined;
-                            description?: string | undefined;
-                            $ref: string;
-                        } & {
-                            $status?: "loading" | "error" | undefined;
-                            $global?: boolean | undefined;
-                        } & {
-                            [x: `x-${string}`]: unknown;
-                        }) | ({
-                            summary?: string | undefined;
-                            description?: string | undefined;
-                            value?: any;
-                            externalValue?: string | undefined;
-                        } & {
-                            [x: `x-${string}`]: unknown;
-                        });
-                    } | undefined;
                     example: any;
                 }) | ({
                     description?: string | undefined;
@@ -1059,13 +1082,32 @@ export declare function filterHttpMethodsOnly(paths: PathsObject): Record<string
                     deprecated?: boolean | undefined;
                     allowEmptyValue?: boolean | undefined;
                     name: string;
-                    in: string;
+                    in: "query" | "header" | "path" | "cookie";
                 } & {
                     [x: `x-${string}`]: unknown;
                 } & {
                     content?: {
                         [x: string]: {
                             example?: any;
+                            examples?: {
+                                [x: string]: ({
+                                    summary?: string | undefined;
+                                    description?: string | undefined;
+                                    value?: any;
+                                    externalValue?: string | undefined;
+                                } & {
+                                    [x: `x-${string}`]: unknown;
+                                }) | ({
+                                    summary?: string | undefined;
+                                    description?: string | undefined;
+                                    $ref: string;
+                                } & {
+                                    $status?: "loading" | "error" | undefined;
+                                    $global?: boolean | undefined;
+                                } & {
+                                    [x: `x-${string}`]: unknown;
+                                });
+                            } | undefined;
                             schema?: ({
                                 discriminator?: ({
                                     mapping?: {
@@ -1091,6 +1133,7 @@ export declare function filterHttpMethodsOnly(paths: PathsObject): Record<string
                                     [x: `x-${string}`]: unknown;
                                 }) | undefined;
                                 example?: any;
+                                examples?: unknown[] | undefined;
                             } & {
                                 [x: `x-${string}`]: unknown;
                             } & {
@@ -1098,25 +1141,6 @@ export declare function filterHttpMethodsOnly(paths: PathsObject): Record<string
                             } & {
                                 [x: string]: unknown;
                             }) | undefined;
-                            examples?: {
-                                [x: string]: ({
-                                    summary?: string | undefined;
-                                    description?: string | undefined;
-                                    value?: any;
-                                    externalValue?: string | undefined;
-                                } & {
-                                    [x: `x-${string}`]: unknown;
-                                }) | ({
-                                    summary?: string | undefined;
-                                    description?: string | undefined;
-                                    $ref: string;
-                                } & {
-                                    $status?: "loading" | "error" | undefined;
-                                    $global?: boolean | undefined;
-                                } & {
-                                    [x: `x-${string}`]: unknown;
-                                });
-                            } | undefined;
                             encoding?: {
                                 [x: string]: {
                                     contentType?: string | undefined;
@@ -1137,9 +1161,37 @@ export declare function filterHttpMethodsOnly(paths: PathsObject): Record<string
                                         } & {
                                             [x: `x-${string}`]: unknown;
                                         } & {
+                                            examples?: {
+                                                [x: string]: ({
+                                                    summary?: string | undefined;
+                                                    description?: string | undefined;
+                                                    value?: any;
+                                                    externalValue?: string | undefined;
+                                                } & {
+                                                    [x: `x-${string}`]: unknown;
+                                                }) | ({
+                                                    summary?: string | undefined;
+                                                    description?: string | undefined;
+                                                    $ref: string;
+                                                } & {
+                                                    $status?: "loading" | "error" | undefined;
+                                                    $global?: boolean | undefined;
+                                                } & {
+                                                    [x: `x-${string}`]: unknown;
+                                                });
+                                            } | undefined;
                                             style?: string | undefined;
                                             explode?: boolean | undefined;
                                             schema?: ({
+                                                summary?: string | undefined;
+                                                description?: string | undefined;
+                                                $ref: string;
+                                            } & {
+                                                $status?: "loading" | "error" | undefined;
+                                                $global?: boolean | undefined;
+                                            } & {
+                                                [x: `x-${string}`]: unknown;
+                                            }) | ({
                                                 discriminator?: ({
                                                     mapping?: {
                                                         [x: string]: string;
@@ -1164,41 +1216,14 @@ export declare function filterHttpMethodsOnly(paths: PathsObject): Record<string
                                                     [x: `x-${string}`]: unknown;
                                                 }) | undefined;
                                                 example?: any;
+                                                examples?: unknown[] | undefined;
                                             } & {
                                                 [x: `x-${string}`]: unknown;
                                             } & {
                                                 'x-tags'?: string[] | undefined;
                                             } & {
                                                 [x: string]: unknown;
-                                            }) | ({
-                                                summary?: string | undefined;
-                                                description?: string | undefined;
-                                                $ref: string;
-                                            } & {
-                                                $status?: "loading" | "error" | undefined;
-                                                $global?: boolean | undefined;
-                                            } & {
-                                                [x: `x-${string}`]: unknown;
                                             }) | undefined;
-                                            examples?: {
-                                                [x: string]: ({
-                                                    summary?: string | undefined;
-                                                    description?: string | undefined;
-                                                    value?: any;
-                                                    externalValue?: string | undefined;
-                                                } & {
-                                                    [x: `x-${string}`]: unknown;
-                                                }) | ({
-                                                    summary?: string | undefined;
-                                                    description?: string | undefined;
-                                                    $ref: string;
-                                                } & {
-                                                    $status?: "loading" | "error" | undefined;
-                                                    $global?: boolean | undefined;
-                                                } & {
-                                                    [x: `x-${string}`]: unknown;
-                                                });
-                                            } | undefined;
                                             example: any;
                                         }) | ({
                                             description?: string | undefined;
@@ -1364,10 +1389,29 @@ export declare function escapePaths(paths: Record<string, Record<string, Operati
         deprecated?: boolean | undefined;
         allowEmptyValue?: boolean | undefined;
         name: string;
-        in: string;
+        in: "query" | "header" | "path" | "cookie";
     } & {
         [x: `x-${string}`]: unknown;
     } & {
+        examples?: {
+            [x: string]: ({
+                summary?: string | undefined;
+                description?: string | undefined;
+                $ref: string;
+            } & {
+                $status?: "loading" | "error" | undefined;
+                $global?: boolean | undefined;
+            } & {
+                [x: `x-${string}`]: unknown;
+            }) | ({
+                summary?: string | undefined;
+                description?: string | undefined;
+                value?: any;
+                externalValue?: string | undefined;
+            } & {
+                [x: `x-${string}`]: unknown;
+            });
+        } | undefined;
         style?: string | undefined;
         explode?: boolean | undefined;
         schema?: ({
@@ -1404,6 +1448,7 @@ export declare function escapePaths(paths: Record<string, Record<string, Operati
                 [x: `x-${string}`]: unknown;
             }) | undefined;
             example?: any;
+            examples?: unknown[] | undefined;
         } & {
             [x: `x-${string}`]: unknown;
         } & {
@@ -1411,25 +1456,6 @@ export declare function escapePaths(paths: Record<string, Record<string, Operati
         } & {
             [x: string]: unknown;
         }) | undefined;
-        examples?: {
-            [x: string]: ({
-                summary?: string | undefined;
-                description?: string | undefined;
-                $ref: string;
-            } & {
-                $status?: "loading" | "error" | undefined;
-                $global?: boolean | undefined;
-            } & {
-                [x: `x-${string}`]: unknown;
-            }) | ({
-                summary?: string | undefined;
-                description?: string | undefined;
-                value?: any;
-                externalValue?: string | undefined;
-            } & {
-                [x: `x-${string}`]: unknown;
-            });
-        } | undefined;
         example: any;
     }) | ({
         description?: string | undefined;
@@ -1437,13 +1463,32 @@ export declare function escapePaths(paths: Record<string, Record<string, Operati
         deprecated?: boolean | undefined;
         allowEmptyValue?: boolean | undefined;
         name: string;
-        in: string;
+        in: "query" | "header" | "path" | "cookie";
     } & {
         [x: `x-${string}`]: unknown;
     } & {
         content?: {
             [x: string]: {
                 example?: any;
+                examples?: {
+                    [x: string]: ({
+                        summary?: string | undefined;
+                        description?: string | undefined;
+                        value?: any;
+                        externalValue?: string | undefined;
+                    } & {
+                        [x: `x-${string}`]: unknown;
+                    }) | ({
+                        summary?: string | undefined;
+                        description?: string | undefined;
+                        $ref: string;
+                    } & {
+                        $status?: "loading" | "error" | undefined;
+                        $global?: boolean | undefined;
+                    } & {
+                        [x: `x-${string}`]: unknown;
+                    });
+                } | undefined;
                 schema?: ({
                     discriminator?: ({
                         mapping?: {
@@ -1469,6 +1514,7 @@ export declare function escapePaths(paths: Record<string, Record<string, Operati
                         [x: `x-${string}`]: unknown;
                     }) | undefined;
                     example?: any;
+                    examples?: unknown[] | undefined;
                 } & {
                     [x: `x-${string}`]: unknown;
                 } & {
@@ -1476,25 +1522,6 @@ export declare function escapePaths(paths: Record<string, Record<string, Operati
                 } & {
                     [x: string]: unknown;
                 }) | undefined;
-                examples?: {
-                    [x: string]: ({
-                        summary?: string | undefined;
-                        description?: string | undefined;
-                        value?: any;
-                        externalValue?: string | undefined;
-                    } & {
-                        [x: `x-${string}`]: unknown;
-                    }) | ({
-                        summary?: string | undefined;
-                        description?: string | undefined;
-                        $ref: string;
-                    } & {
-                        $status?: "loading" | "error" | undefined;
-                        $global?: boolean | undefined;
-                    } & {
-                        [x: `x-${string}`]: unknown;
-                    });
-                } | undefined;
                 encoding?: {
                     [x: string]: {
                         contentType?: string | undefined;
@@ -1515,9 +1542,37 @@ export declare function escapePaths(paths: Record<string, Record<string, Operati
                             } & {
                                 [x: `x-${string}`]: unknown;
                             } & {
+                                examples?: {
+                                    [x: string]: ({
+                                        summary?: string | undefined;
+                                        description?: string | undefined;
+                                        value?: any;
+                                        externalValue?: string | undefined;
+                                    } & {
+                                        [x: `x-${string}`]: unknown;
+                                    }) | ({
+                                        summary?: string | undefined;
+                                        description?: string | undefined;
+                                        $ref: string;
+                                    } & {
+                                        $status?: "loading" | "error" | undefined;
+                                        $global?: boolean | undefined;
+                                    } & {
+                                        [x: `x-${string}`]: unknown;
+                                    });
+                                } | undefined;
                                 style?: string | undefined;
                                 explode?: boolean | undefined;
                                 schema?: ({
+                                    summary?: string | undefined;
+                                    description?: string | undefined;
+                                    $ref: string;
+                                } & {
+                                    $status?: "loading" | "error" | undefined;
+                                    $global?: boolean | undefined;
+                                } & {
+                                    [x: `x-${string}`]: unknown;
+                                }) | ({
                                     discriminator?: ({
                                         mapping?: {
                                             [x: string]: string;
@@ -1542,41 +1597,14 @@ export declare function escapePaths(paths: Record<string, Record<string, Operati
                                         [x: `x-${string}`]: unknown;
                                     }) | undefined;
                                     example?: any;
+                                    examples?: unknown[] | undefined;
                                 } & {
                                     [x: `x-${string}`]: unknown;
                                 } & {
                                     'x-tags'?: string[] | undefined;
                                 } & {
                                     [x: string]: unknown;
-                                }) | ({
-                                    summary?: string | undefined;
-                                    description?: string | undefined;
-                                    $ref: string;
-                                } & {
-                                    $status?: "loading" | "error" | undefined;
-                                    $global?: boolean | undefined;
-                                } & {
-                                    [x: `x-${string}`]: unknown;
                                 }) | undefined;
-                                examples?: {
-                                    [x: string]: ({
-                                        summary?: string | undefined;
-                                        description?: string | undefined;
-                                        value?: any;
-                                        externalValue?: string | undefined;
-                                    } & {
-                                        [x: `x-${string}`]: unknown;
-                                    }) | ({
-                                        summary?: string | undefined;
-                                        description?: string | undefined;
-                                        $ref: string;
-                                    } & {
-                                        $status?: "loading" | "error" | undefined;
-                                        $global?: boolean | undefined;
-                                    } & {
-                                        [x: `x-${string}`]: unknown;
-                                    });
-                                } | undefined;
                                 example: any;
                             }) | ({
                                 description?: string | undefined;
@@ -1616,6 +1644,25 @@ export declare function escapePaths(paths: Record<string, Record<string, Operati
         content: {
             [x: string]: {
                 example?: any;
+                examples?: {
+                    [x: string]: ({
+                        summary?: string | undefined;
+                        description?: string | undefined;
+                        value?: any;
+                        externalValue?: string | undefined;
+                    } & {
+                        [x: `x-${string}`]: unknown;
+                    }) | ({
+                        summary?: string | undefined;
+                        description?: string | undefined;
+                        $ref: string;
+                    } & {
+                        $status?: "loading" | "error" | undefined;
+                        $global?: boolean | undefined;
+                    } & {
+                        [x: `x-${string}`]: unknown;
+                    });
+                } | undefined;
                 schema?: ({
                     discriminator?: ({
                         mapping?: {
@@ -1641,6 +1688,7 @@ export declare function escapePaths(paths: Record<string, Record<string, Operati
                         [x: `x-${string}`]: unknown;
                     }) | undefined;
                     example?: any;
+                    examples?: unknown[] | undefined;
                 } & {
                     [x: `x-${string}`]: unknown;
                 } & {
@@ -1648,25 +1696,6 @@ export declare function escapePaths(paths: Record<string, Record<string, Operati
                 } & {
                     [x: string]: unknown;
                 }) | undefined;
-                examples?: {
-                    [x: string]: ({
-                        summary?: string | undefined;
-                        description?: string | undefined;
-                        value?: any;
-                        externalValue?: string | undefined;
-                    } & {
-                        [x: `x-${string}`]: unknown;
-                    }) | ({
-                        summary?: string | undefined;
-                        description?: string | undefined;
-                        $ref: string;
-                    } & {
-                        $status?: "loading" | "error" | undefined;
-                        $global?: boolean | undefined;
-                    } & {
-                        [x: `x-${string}`]: unknown;
-                    });
-                } | undefined;
                 encoding?: {
                     [x: string]: {
                         contentType?: string | undefined;
@@ -1687,9 +1716,37 @@ export declare function escapePaths(paths: Record<string, Record<string, Operati
                             } & {
                                 [x: `x-${string}`]: unknown;
                             } & {
+                                examples?: {
+                                    [x: string]: ({
+                                        summary?: string | undefined;
+                                        description?: string | undefined;
+                                        value?: any;
+                                        externalValue?: string | undefined;
+                                    } & {
+                                        [x: `x-${string}`]: unknown;
+                                    }) | ({
+                                        summary?: string | undefined;
+                                        description?: string | undefined;
+                                        $ref: string;
+                                    } & {
+                                        $status?: "loading" | "error" | undefined;
+                                        $global?: boolean | undefined;
+                                    } & {
+                                        [x: `x-${string}`]: unknown;
+                                    });
+                                } | undefined;
                                 style?: string | undefined;
                                 explode?: boolean | undefined;
                                 schema?: ({
+                                    summary?: string | undefined;
+                                    description?: string | undefined;
+                                    $ref: string;
+                                } & {
+                                    $status?: "loading" | "error" | undefined;
+                                    $global?: boolean | undefined;
+                                } & {
+                                    [x: `x-${string}`]: unknown;
+                                }) | ({
                                     discriminator?: ({
                                         mapping?: {
                                             [x: string]: string;
@@ -1714,41 +1771,14 @@ export declare function escapePaths(paths: Record<string, Record<string, Operati
                                         [x: `x-${string}`]: unknown;
                                     }) | undefined;
                                     example?: any;
+                                    examples?: unknown[] | undefined;
                                 } & {
                                     [x: `x-${string}`]: unknown;
                                 } & {
                                     'x-tags'?: string[] | undefined;
                                 } & {
                                     [x: string]: unknown;
-                                }) | ({
-                                    summary?: string | undefined;
-                                    description?: string | undefined;
-                                    $ref: string;
-                                } & {
-                                    $status?: "loading" | "error" | undefined;
-                                    $global?: boolean | undefined;
-                                } & {
-                                    [x: `x-${string}`]: unknown;
                                 }) | undefined;
-                                examples?: {
-                                    [x: string]: ({
-                                        summary?: string | undefined;
-                                        description?: string | undefined;
-                                        value?: any;
-                                        externalValue?: string | undefined;
-                                    } & {
-                                        [x: `x-${string}`]: unknown;
-                                    }) | ({
-                                        summary?: string | undefined;
-                                        description?: string | undefined;
-                                        $ref: string;
-                                    } & {
-                                        $status?: "loading" | "error" | undefined;
-                                        $global?: boolean | undefined;
-                                    } & {
-                                        [x: `x-${string}`]: unknown;
-                                    });
-                                } | undefined;
                                 example: any;
                             }) | ({
                                 description?: string | undefined;
@@ -1795,9 +1825,37 @@ export declare function escapePaths(paths: Record<string, Record<string, Operati
                 } & {
                     [x: `x-${string}`]: unknown;
                 } & {
+                    examples?: {
+                        [x: string]: ({
+                            summary?: string | undefined;
+                            description?: string | undefined;
+                            value?: any;
+                            externalValue?: string | undefined;
+                        } & {
+                            [x: `x-${string}`]: unknown;
+                        }) | ({
+                            summary?: string | undefined;
+                            description?: string | undefined;
+                            $ref: string;
+                        } & {
+                            $status?: "loading" | "error" | undefined;
+                            $global?: boolean | undefined;
+                        } & {
+                            [x: `x-${string}`]: unknown;
+                        });
+                    } | undefined;
                     style?: string | undefined;
                     explode?: boolean | undefined;
                     schema?: ({
+                        summary?: string | undefined;
+                        description?: string | undefined;
+                        $ref: string;
+                    } & {
+                        $status?: "loading" | "error" | undefined;
+                        $global?: boolean | undefined;
+                    } & {
+                        [x: `x-${string}`]: unknown;
+                    }) | ({
                         discriminator?: ({
                             mapping?: {
                                 [x: string]: string;
@@ -1822,41 +1880,14 @@ export declare function escapePaths(paths: Record<string, Record<string, Operati
                             [x: `x-${string}`]: unknown;
                         }) | undefined;
                         example?: any;
+                        examples?: unknown[] | undefined;
                     } & {
                         [x: `x-${string}`]: unknown;
                     } & {
                         'x-tags'?: string[] | undefined;
                     } & {
                         [x: string]: unknown;
-                    }) | ({
-                        summary?: string | undefined;
-                        description?: string | undefined;
-                        $ref: string;
-                    } & {
-                        $status?: "loading" | "error" | undefined;
-                        $global?: boolean | undefined;
-                    } & {
-                        [x: `x-${string}`]: unknown;
                     }) | undefined;
-                    examples?: {
-                        [x: string]: ({
-                            summary?: string | undefined;
-                            description?: string | undefined;
-                            $ref: string;
-                        } & {
-                            $status?: "loading" | "error" | undefined;
-                            $global?: boolean | undefined;
-                        } & {
-                            [x: `x-${string}`]: unknown;
-                        }) | ({
-                            summary?: string | undefined;
-                            description?: string | undefined;
-                            value?: any;
-                            externalValue?: string | undefined;
-                        } & {
-                            [x: `x-${string}`]: unknown;
-                        });
-                    } | undefined;
                     example: any;
                 }) | ({
                     description?: string | undefined;
@@ -1868,6 +1899,25 @@ export declare function escapePaths(paths: Record<string, Record<string, Operati
                     content?: {
                         [x: string]: {
                             example?: any;
+                            examples?: {
+                                [x: string]: ({
+                                    summary?: string | undefined;
+                                    description?: string | undefined;
+                                    value?: any;
+                                    externalValue?: string | undefined;
+                                } & {
+                                    [x: `x-${string}`]: unknown;
+                                }) | ({
+                                    summary?: string | undefined;
+                                    description?: string | undefined;
+                                    $ref: string;
+                                } & {
+                                    $status?: "loading" | "error" | undefined;
+                                    $global?: boolean | undefined;
+                                } & {
+                                    [x: `x-${string}`]: unknown;
+                                });
+                            } | undefined;
                             schema?: ({
                                 discriminator?: ({
                                     mapping?: {
@@ -1893,6 +1943,7 @@ export declare function escapePaths(paths: Record<string, Record<string, Operati
                                     [x: `x-${string}`]: unknown;
                                 }) | undefined;
                                 example?: any;
+                                examples?: unknown[] | undefined;
                             } & {
                                 [x: `x-${string}`]: unknown;
                             } & {
@@ -1900,25 +1951,6 @@ export declare function escapePaths(paths: Record<string, Record<string, Operati
                             } & {
                                 [x: string]: unknown;
                             }) | undefined;
-                            examples?: {
-                                [x: string]: ({
-                                    summary?: string | undefined;
-                                    description?: string | undefined;
-                                    $ref: string;
-                                } & {
-                                    $status?: "loading" | "error" | undefined;
-                                    $global?: boolean | undefined;
-                                } & {
-                                    [x: `x-${string}`]: unknown;
-                                }) | ({
-                                    summary?: string | undefined;
-                                    description?: string | undefined;
-                                    value?: any;
-                                    externalValue?: string | undefined;
-                                } & {
-                                    [x: `x-${string}`]: unknown;
-                                });
-                            } | undefined;
                             encoding?: {
                                 [x: string]: {
                                     contentType?: string | undefined;
@@ -1930,9 +1962,37 @@ export declare function escapePaths(paths: Record<string, Record<string, Operati
                                         } & {
                                             [x: `x-${string}`]: unknown;
                                         } & {
+                                            examples?: {
+                                                [x: string]: ({
+                                                    summary?: string | undefined;
+                                                    description?: string | undefined;
+                                                    value?: any;
+                                                    externalValue?: string | undefined;
+                                                } & {
+                                                    [x: `x-${string}`]: unknown;
+                                                }) | ({
+                                                    summary?: string | undefined;
+                                                    description?: string | undefined;
+                                                    $ref: string;
+                                                } & {
+                                                    $status?: "loading" | "error" | undefined;
+                                                    $global?: boolean | undefined;
+                                                } & {
+                                                    [x: `x-${string}`]: unknown;
+                                                });
+                                            } | undefined;
                                             style?: string | undefined;
                                             explode?: boolean | undefined;
                                             schema?: ({
+                                                summary?: string | undefined;
+                                                description?: string | undefined;
+                                                $ref: string;
+                                            } & {
+                                                $status?: "loading" | "error" | undefined;
+                                                $global?: boolean | undefined;
+                                            } & {
+                                                [x: `x-${string}`]: unknown;
+                                            }) | ({
                                                 discriminator?: ({
                                                     mapping?: {
                                                         [x: string]: string;
@@ -1957,41 +2017,14 @@ export declare function escapePaths(paths: Record<string, Record<string, Operati
                                                     [x: `x-${string}`]: unknown;
                                                 }) | undefined;
                                                 example?: any;
+                                                examples?: unknown[] | undefined;
                                             } & {
                                                 [x: `x-${string}`]: unknown;
                                             } & {
                                                 'x-tags'?: string[] | undefined;
                                             } & {
                                                 [x: string]: unknown;
-                                            }) | ({
-                                                summary?: string | undefined;
-                                                description?: string | undefined;
-                                                $ref: string;
-                                            } & {
-                                                $status?: "loading" | "error" | undefined;
-                                                $global?: boolean | undefined;
-                                            } & {
-                                                [x: `x-${string}`]: unknown;
                                             }) | undefined;
-                                            examples?: {
-                                                [x: string]: ({
-                                                    summary?: string | undefined;
-                                                    description?: string | undefined;
-                                                    $ref: string;
-                                                } & {
-                                                    $status?: "loading" | "error" | undefined;
-                                                    $global?: boolean | undefined;
-                                                } & {
-                                                    [x: `x-${string}`]: unknown;
-                                                }) | ({
-                                                    summary?: string | undefined;
-                                                    description?: string | undefined;
-                                                    value?: any;
-                                                    externalValue?: string | undefined;
-                                                } & {
-                                                    [x: `x-${string}`]: unknown;
-                                                });
-                                            } | undefined;
                                             example: any;
                                         }) | ({
                                             description?: string | undefined;
@@ -2032,6 +2065,25 @@ export declare function escapePaths(paths: Record<string, Record<string, Operati
             content?: {
                 [x: string]: {
                     example?: any;
+                    examples?: {
+                        [x: string]: ({
+                            summary?: string | undefined;
+                            description?: string | undefined;
+                            value?: any;
+                            externalValue?: string | undefined;
+                        } & {
+                            [x: `x-${string}`]: unknown;
+                        }) | ({
+                            summary?: string | undefined;
+                            description?: string | undefined;
+                            $ref: string;
+                        } & {
+                            $status?: "loading" | "error" | undefined;
+                            $global?: boolean | undefined;
+                        } & {
+                            [x: `x-${string}`]: unknown;
+                        });
+                    } | undefined;
                     schema?: ({
                         discriminator?: ({
                             mapping?: {
@@ -2057,6 +2109,7 @@ export declare function escapePaths(paths: Record<string, Record<string, Operati
                             [x: `x-${string}`]: unknown;
                         }) | undefined;
                         example?: any;
+                        examples?: unknown[] | undefined;
                     } & {
                         [x: `x-${string}`]: unknown;
                     } & {
@@ -2064,25 +2117,6 @@ export declare function escapePaths(paths: Record<string, Record<string, Operati
                     } & {
                         [x: string]: unknown;
                     }) | undefined;
-                    examples?: {
-                        [x: string]: ({
-                            summary?: string | undefined;
-                            description?: string | undefined;
-                            value?: any;
-                            externalValue?: string | undefined;
-                        } & {
-                            [x: `x-${string}`]: unknown;
-                        }) | ({
-                            summary?: string | undefined;
-                            description?: string | undefined;
-                            $ref: string;
-                        } & {
-                            $status?: "loading" | "error" | undefined;
-                            $global?: boolean | undefined;
-                        } & {
-                            [x: `x-${string}`]: unknown;
-                        });
-                    } | undefined;
                     encoding?: {
                         [x: string]: {
                             contentType?: string | undefined;
@@ -2103,9 +2137,37 @@ export declare function escapePaths(paths: Record<string, Record<string, Operati
                                 } & {
                                     [x: `x-${string}`]: unknown;
                                 } & {
+                                    examples?: {
+                                        [x: string]: ({
+                                            summary?: string | undefined;
+                                            description?: string | undefined;
+                                            value?: any;
+                                            externalValue?: string | undefined;
+                                        } & {
+                                            [x: `x-${string}`]: unknown;
+                                        }) | ({
+                                            summary?: string | undefined;
+                                            description?: string | undefined;
+                                            $ref: string;
+                                        } & {
+                                            $status?: "loading" | "error" | undefined;
+                                            $global?: boolean | undefined;
+                                        } & {
+                                            [x: `x-${string}`]: unknown;
+                                        });
+                                    } | undefined;
                                     style?: string | undefined;
                                     explode?: boolean | undefined;
                                     schema?: ({
+                                        summary?: string | undefined;
+                                        description?: string | undefined;
+                                        $ref: string;
+                                    } & {
+                                        $status?: "loading" | "error" | undefined;
+                                        $global?: boolean | undefined;
+                                    } & {
+                                        [x: `x-${string}`]: unknown;
+                                    }) | ({
                                         discriminator?: ({
                                             mapping?: {
                                                 [x: string]: string;
@@ -2130,41 +2192,14 @@ export declare function escapePaths(paths: Record<string, Record<string, Operati
                                             [x: `x-${string}`]: unknown;
                                         }) | undefined;
                                         example?: any;
+                                        examples?: unknown[] | undefined;
                                     } & {
                                         [x: `x-${string}`]: unknown;
                                     } & {
                                         'x-tags'?: string[] | undefined;
                                     } & {
                                         [x: string]: unknown;
-                                    }) | ({
-                                        summary?: string | undefined;
-                                        description?: string | undefined;
-                                        $ref: string;
-                                    } & {
-                                        $status?: "loading" | "error" | undefined;
-                                        $global?: boolean | undefined;
-                                    } & {
-                                        [x: `x-${string}`]: unknown;
                                     }) | undefined;
-                                    examples?: {
-                                        [x: string]: ({
-                                            summary?: string | undefined;
-                                            description?: string | undefined;
-                                            value?: any;
-                                            externalValue?: string | undefined;
-                                        } & {
-                                            [x: `x-${string}`]: unknown;
-                                        }) | ({
-                                            summary?: string | undefined;
-                                            description?: string | undefined;
-                                            $ref: string;
-                                        } & {
-                                            $status?: "loading" | "error" | undefined;
-                                            $global?: boolean | undefined;
-                                        } & {
-                                            [x: `x-${string}`]: unknown;
-                                        });
-                                    } | undefined;
                                     example: any;
                                 }) | ({
                                     description?: string | undefined;
@@ -2282,10 +2317,29 @@ export declare function escapePaths(paths: Record<string, Record<string, Operati
                     deprecated?: boolean | undefined;
                     allowEmptyValue?: boolean | undefined;
                     name: string;
-                    in: string;
+                    in: "query" | "header" | "path" | "cookie";
                 } & {
                     [x: `x-${string}`]: unknown;
                 } & {
+                    examples?: {
+                        [x: string]: ({
+                            summary?: string | undefined;
+                            description?: string | undefined;
+                            $ref: string;
+                        } & {
+                            $status?: "loading" | "error" | undefined;
+                            $global?: boolean | undefined;
+                        } & {
+                            [x: `x-${string}`]: unknown;
+                        }) | ({
+                            summary?: string | undefined;
+                            description?: string | undefined;
+                            value?: any;
+                            externalValue?: string | undefined;
+                        } & {
+                            [x: `x-${string}`]: unknown;
+                        });
+                    } | undefined;
                     style?: string | undefined;
                     explode?: boolean | undefined;
                     schema?: ({
@@ -2322,6 +2376,7 @@ export declare function escapePaths(paths: Record<string, Record<string, Operati
                             [x: `x-${string}`]: unknown;
                         }) | undefined;
                         example?: any;
+                        examples?: unknown[] | undefined;
                     } & {
                         [x: `x-${string}`]: unknown;
                     } & {
@@ -2329,25 +2384,6 @@ export declare function escapePaths(paths: Record<string, Record<string, Operati
                     } & {
                         [x: string]: unknown;
                     }) | undefined;
-                    examples?: {
-                        [x: string]: ({
-                            summary?: string | undefined;
-                            description?: string | undefined;
-                            $ref: string;
-                        } & {
-                            $status?: "loading" | "error" | undefined;
-                            $global?: boolean | undefined;
-                        } & {
-                            [x: `x-${string}`]: unknown;
-                        }) | ({
-                            summary?: string | undefined;
-                            description?: string | undefined;
-                            value?: any;
-                            externalValue?: string | undefined;
-                        } & {
-                            [x: `x-${string}`]: unknown;
-                        });
-                    } | undefined;
                     example: any;
                 }) | ({
                     description?: string | undefined;
@@ -2355,13 +2391,32 @@ export declare function escapePaths(paths: Record<string, Record<string, Operati
                     deprecated?: boolean | undefined;
                     allowEmptyValue?: boolean | undefined;
                     name: string;
-                    in: string;
+                    in: "query" | "header" | "path" | "cookie";
                 } & {
                     [x: `x-${string}`]: unknown;
                 } & {
                     content?: {
                         [x: string]: {
                             example?: any;
+                            examples?: {
+                                [x: string]: ({
+                                    summary?: string | undefined;
+                                    description?: string | undefined;
+                                    value?: any;
+                                    externalValue?: string | undefined;
+                                } & {
+                                    [x: `x-${string}`]: unknown;
+                                }) | ({
+                                    summary?: string | undefined;
+                                    description?: string | undefined;
+                                    $ref: string;
+                                } & {
+                                    $status?: "loading" | "error" | undefined;
+                                    $global?: boolean | undefined;
+                                } & {
+                                    [x: `x-${string}`]: unknown;
+                                });
+                            } | undefined;
                             schema?: ({
                                 discriminator?: ({
                                     mapping?: {
@@ -2387,6 +2442,7 @@ export declare function escapePaths(paths: Record<string, Record<string, Operati
                                     [x: `x-${string}`]: unknown;
                                 }) | undefined;
                                 example?: any;
+                                examples?: unknown[] | undefined;
                             } & {
                                 [x: `x-${string}`]: unknown;
                             } & {
@@ -2394,25 +2450,6 @@ export declare function escapePaths(paths: Record<string, Record<string, Operati
                             } & {
                                 [x: string]: unknown;
                             }) | undefined;
-                            examples?: {
-                                [x: string]: ({
-                                    summary?: string | undefined;
-                                    description?: string | undefined;
-                                    value?: any;
-                                    externalValue?: string | undefined;
-                                } & {
-                                    [x: `x-${string}`]: unknown;
-                                }) | ({
-                                    summary?: string | undefined;
-                                    description?: string | undefined;
-                                    $ref: string;
-                                } & {
-                                    $status?: "loading" | "error" | undefined;
-                                    $global?: boolean | undefined;
-                                } & {
-                                    [x: `x-${string}`]: unknown;
-                                });
-                            } | undefined;
                             encoding?: {
                                 [x: string]: {
                                     contentType?: string | undefined;
@@ -2433,9 +2470,37 @@ export declare function escapePaths(paths: Record<string, Record<string, Operati
                                         } & {
                                             [x: `x-${string}`]: unknown;
                                         } & {
+                                            examples?: {
+                                                [x: string]: ({
+                                                    summary?: string | undefined;
+                                                    description?: string | undefined;
+                                                    value?: any;
+                                                    externalValue?: string | undefined;
+                                                } & {
+                                                    [x: `x-${string}`]: unknown;
+                                                }) | ({
+                                                    summary?: string | undefined;
+                                                    description?: string | undefined;
+                                                    $ref: string;
+                                                } & {
+                                                    $status?: "loading" | "error" | undefined;
+                                                    $global?: boolean | undefined;
+                                                } & {
+                                                    [x: `x-${string}`]: unknown;
+                                                });
+                                            } | undefined;
                                             style?: string | undefined;
                                             explode?: boolean | undefined;
                                             schema?: ({
+                                                summary?: string | undefined;
+                                                description?: string | undefined;
+                                                $ref: string;
+                                            } & {
+                                                $status?: "loading" | "error" | undefined;
+                                                $global?: boolean | undefined;
+                                            } & {
+                                                [x: `x-${string}`]: unknown;
+                                            }) | ({
                                                 discriminator?: ({
                                                     mapping?: {
                                                         [x: string]: string;
@@ -2460,41 +2525,14 @@ export declare function escapePaths(paths: Record<string, Record<string, Operati
                                                     [x: `x-${string}`]: unknown;
                                                 }) | undefined;
                                                 example?: any;
+                                                examples?: unknown[] | undefined;
                                             } & {
                                                 [x: `x-${string}`]: unknown;
                                             } & {
                                                 'x-tags'?: string[] | undefined;
                                             } & {
                                                 [x: string]: unknown;
-                                            }) | ({
-                                                summary?: string | undefined;
-                                                description?: string | undefined;
-                                                $ref: string;
-                                            } & {
-                                                $status?: "loading" | "error" | undefined;
-                                                $global?: boolean | undefined;
-                                            } & {
-                                                [x: `x-${string}`]: unknown;
                                             }) | undefined;
-                                            examples?: {
-                                                [x: string]: ({
-                                                    summary?: string | undefined;
-                                                    description?: string | undefined;
-                                                    value?: any;
-                                                    externalValue?: string | undefined;
-                                                } & {
-                                                    [x: `x-${string}`]: unknown;
-                                                }) | ({
-                                                    summary?: string | undefined;
-                                                    description?: string | undefined;
-                                                    $ref: string;
-                                                } & {
-                                                    $status?: "loading" | "error" | undefined;
-                                                    $global?: boolean | undefined;
-                                                } & {
-                                                    [x: `x-${string}`]: unknown;
-                                                });
-                                            } | undefined;
                                             example: any;
                                         }) | ({
                                             description?: string | undefined;
@@ -2652,7 +2690,7 @@ export declare function externalizePathReferences(document: OpenApiDocument, met
 /**
  * Create server state workspace store
  */
-export declare function createServerWorkspaceStore(workspaceProps: CreateServerWorkspaceStore): {
+export declare function createServerWorkspaceStore(workspaceProps: CreateServerWorkspaceStore): Promise<{
     /**
      * Generates workspace chunks by writing components and operations to the filesystem.
      *
@@ -2678,7 +2716,9 @@ export declare function createServerWorkspaceStore(workspaceProps: CreateServerW
      * @returns The complete workspace document
      */
     getWorkspace: () => {
-        documents: Record<string, Record<string, unknown>>;
+        documents: Record<string, OpenApiDocument & {
+            [extensions.document.navigation]: TraversedEntry[];
+        }>;
         "x-scalar-dark-mode"?: boolean | undefined;
         "x-scalar-default-client"?: string | undefined;
         "x-scalar-active-document"?: string | undefined;
@@ -2704,20 +2744,16 @@ export declare function createServerWorkspaceStore(workspaceProps: CreateServerW
      */
     get: (pointer: string) => unknown;
     /**
-     * Adds a new document to the workspace.
+     * Adds a new document to the workspace asynchronously.
      *
-     * The document will be:
-     * - Upgraded to OpenAPI 3.1 if needed
-     * - Split into components and operations chunks
-     * - Have its references externalized based on the workspace mode
-     * - Added to the workspace with its metadata
+     * This function:
+     * 1. Loads the document using the provided input
+     * 2. Checks if the document loaded successfully
+     * 3. If successful, adds the document to the workspace using addDocumentSync
      *
-     * @param document - The OpenAPI document to add
-     * @param meta - Document metadata including required name and optional settings
+     * @param input - The document input containing the document source and metadata
      */
-    addDocument: (document: Record<string, unknown>, meta: {
-        name: string;
-    } & WorkspaceDocumentMeta) => void;
-};
+    addDocument: (input: WorkspaceDocumentInput) => Promise<void>;
+}>;
 export {};
 //# sourceMappingURL=server.d.ts.map