@scalar/api-reference 1.28.12 → 1.28.13

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (19) hide show
  1. package/CHANGELOG.md +17 -0
  2. package/dist/browser/standalone.js +5659 -5613
  3. package/dist/browser/webpack-stats.json +1 -1
  4. package/dist/components/Content/Schema/SchemaDiscriminator.vue.d.ts.map +1 -1
  5. package/dist/components/Content/Schema/SchemaDiscriminator.vue.js +1 -1
  6. package/dist/components/Content/Schema/SchemaDiscriminator.vue2.js +37 -37
  7. package/dist/components/Content/Schema/SchemaProperty.vue.d.ts.map +1 -1
  8. package/dist/components/Content/Schema/SchemaProperty.vue.js +2 -2
  9. package/dist/features/ApiClientModal/ApiClientModal.vue.d.ts.map +1 -1
  10. package/dist/features/ApiClientModal/ApiClientModal.vue.js +23 -20
  11. package/dist/features/ApiClientModal/useApiClient.d.ts +308 -8
  12. package/dist/features/ApiClientModal/useApiClient.d.ts.map +1 -1
  13. package/dist/features/Operation/Operation.vue.d.ts.map +1 -1
  14. package/dist/features/Operation/Operation.vue.js +29 -19
  15. package/dist/helpers/get-request.d.ts +15 -0
  16. package/dist/helpers/get-request.d.ts.map +1 -1
  17. package/dist/index.js +1 -1
  18. package/dist/style.css +1 -1
  19. package/package.json +10 -10
package/dist/features/ApiClientModal/useApiClient.d.ts CHANGED
@@ -276,6 +276,21 @@ declare const client: import("vue").Ref<{
276
276
  }[] | undefined;
277
277
  requestBody?: any;
278
278
  responses?: Record<string, any> | undefined;
279
+ "x-codeSamples"?: {
280
+ source: string;
281
+ label?: string | undefined;
282
+ lang?: string | undefined;
283
+ }[] | undefined;
284
+ "x-code-samples"?: {
285
+ source: string;
286
+ label?: string | undefined;
287
+ lang?: string | undefined;
288
+ }[] | undefined;
289
+ "x-custom-examples"?: {
290
+ source: string;
291
+ label?: string | undefined;
292
+ lang?: string | undefined;
293
+ }[] | undefined;
279
294
  "x-scalar-stability"?: import("@scalar/types").XScalarStability | undefined;
280
295
  }>;
281
296
  collections: Record<string, {
@@ -1280,6 +1295,21 @@ declare const client: import("vue").Ref<{
1280
1295
  }[] | undefined;
1281
1296
  requestBody?: any;
1282
1297
  responses?: Record<string, any> | undefined;
1298
+ "x-codeSamples"?: {
1299
+ source: string;
1300
+ label?: string | undefined;
1301
+ lang?: string | undefined;
1302
+ }[] | undefined;
1303
+ "x-code-samples"?: {
1304
+ source: string;
1305
+ label?: string | undefined;
1306
+ lang?: string | undefined;
1307
+ }[] | undefined;
1308
+ "x-custom-examples"?: {
1309
+ source: string;
1310
+ label?: string | undefined;
1311
+ lang?: string | undefined;
1312
+ }[] | undefined;
1283
1313
  "x-scalar-stability"?: import("@scalar/types").XScalarStability | undefined;
1284
1314
  }) => void;
1285
1315
  add: (payload: import("@scalar/oas-utils/entities/spec").RequestPayload, collectionUid: import("@scalar/oas-utils/entities/spec").Collection["uid"]) => void | {
@@ -1320,6 +1350,21 @@ declare const client: import("vue").Ref<{
1320
1350
  }[] | undefined;
1321
1351
  requestBody?: any;
1322
1352
  responses?: Record<string, any> | undefined;
1353
+ "x-codeSamples"?: {
1354
+ source: string;
1355
+ label?: string | undefined;
1356
+ lang?: string | undefined;
1357
+ }[] | undefined;
1358
+ "x-code-samples"?: {
1359
+ source: string;
1360
+ label?: string | undefined;
1361
+ lang?: string | undefined;
1362
+ }[] | undefined;
1363
+ "x-custom-examples"?: {
1364
+ source: string;
1365
+ label?: string | undefined;
1366
+ lang?: string | undefined;
1367
+ }[] | undefined;
1323
1368
  "x-scalar-stability"?: import("@scalar/types").XScalarStability | undefined;
1324
1369
  };
1325
1370
  delete: (request: import("@scalar/oas-utils/entities/spec").Request, collectionUid: import("@scalar/oas-utils/entities/spec").Collection["uid"]) => void;
@@ -1361,9 +1406,24 @@ declare const client: import("vue").Ref<{
1361
1406
  }[] | undefined;
1362
1407
  requestBody?: any;
1363
1408
  responses?: Record<string, any> | undefined;
1409
+ "x-codeSamples"?: {
1410
+ source: string;
1411
+ label?: string | undefined;
1412
+ lang?: string | undefined;
1413
+ }[] | undefined;
1414
+ "x-code-samples"?: {
1415
+ source: string;
1416
+ label?: string | undefined;
1417
+ lang?: string | undefined;
1418
+ }[] | undefined;
1419
+ "x-custom-examples"?: {
1420
+ source: string;
1421
+ label?: string | undefined;
1422
+ lang?: string | undefined;
1423
+ }[] | undefined;
1364
1424
  "x-scalar-stability"?: import("@scalar/types").XScalarStability | undefined;
1365
1425
  }) => void;
1366
- edit: <P extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "x-scalar-stability" | "path" | "method" | "type" | "uid" | "selectedSecuritySchemeUids" | "servers" | "selectedServerUid" | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.description" | "externalDocs.url" | `selectedSecuritySchemeUids.${number}` | `selectedSecuritySchemeUids.${number}.${number}` | `servers.${number}` | "examples" | `requestBody.${string}` | `examples.${number}` | `parameters.${number}` | `parameters.${number}.description` | `parameters.${number}.deprecated` | `parameters.${number}.example` | `parameters.${number}.name` | `parameters.${number}.in` | `parameters.${number}.style` | `parameters.${number}.examples` | `parameters.${number}.content` | `parameters.${number}.required` | `parameters.${number}.schema` | `parameters.${number}.examples.${number}` | `parameters.${number}.examples.${string}` | `responses.${string}`>(uid: (string & import("zod").BRAND<"operation">) | null | undefined, path: P, value: P extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "x-scalar-stability" | "path" | "method" | "type" | "uid" | "selectedSecuritySchemeUids" | "servers" | "selectedServerUid" | "examples" ? {
1426
+ edit: <P extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "x-codeSamples" | "x-code-samples" | "x-custom-examples" | "x-scalar-stability" | "path" | "method" | "type" | "uid" | "selectedSecuritySchemeUids" | "servers" | "selectedServerUid" | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.description" | "externalDocs.url" | `selectedSecuritySchemeUids.${number}` | `selectedSecuritySchemeUids.${number}.${number}` | `servers.${number}` | "examples" | `requestBody.${string}` | `examples.${number}` | `parameters.${number}` | `parameters.${number}.description` | `parameters.${number}.deprecated` | `parameters.${number}.example` | `parameters.${number}.name` | `parameters.${number}.in` | `parameters.${number}.style` | `parameters.${number}.examples` | `parameters.${number}.content` | `parameters.${number}.required` | `parameters.${number}.schema` | `parameters.${number}.examples.${number}` | `parameters.${number}.examples.${string}` | `responses.${string}` | `x-codeSamples.${number}` | `x-codeSamples.${number}.label` | `x-codeSamples.${number}.source` | `x-codeSamples.${number}.lang` | `x-code-samples.${number}` | `x-code-samples.${number}.label` | `x-code-samples.${number}.source` | `x-code-samples.${number}.lang` | `x-custom-examples.${number}` | `x-custom-examples.${number}.label` | `x-custom-examples.${number}.source` | `x-custom-examples.${number}.lang`>(uid: (string & import("zod").BRAND<"operation">) | null | undefined, path: P, value: P extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "x-codeSamples" | "x-code-samples" | "x-custom-examples" | "x-scalar-stability" | "path" | "method" | "type" | "uid" | "selectedSecuritySchemeUids" | "servers" | "selectedServerUid" | "examples" ? {
1367
1427
  uid: string & import("zod").BRAND<"operation">;
1368
1428
  path: string;
1369
1429
  type: "request";
@@ -1401,8 +1461,23 @@ declare const client: import("vue").Ref<{
1401
1461
  }[] | undefined;
1402
1462
  requestBody?: any;
1403
1463
  responses?: Record<string, any> | undefined;
1464
+ "x-codeSamples"?: {
1465
+ source: string;
1466
+ label?: string | undefined;
1467
+ lang?: string | undefined;
1468
+ }[] | undefined;
1469
+ "x-code-samples"?: {
1470
+ source: string;
1471
+ label?: string | undefined;
1472
+ lang?: string | undefined;
1473
+ }[] | undefined;
1474
+ "x-custom-examples"?: {
1475
+ source: string;
1476
+ label?: string | undefined;
1477
+ lang?: string | undefined;
1478
+ }[] | undefined;
1404
1479
  "x-scalar-stability"?: import("@scalar/types").XScalarStability | undefined;
1405
- }[P] : P extends `${infer K}.${infer R}` ? K extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "x-scalar-stability" | "path" | "method" | "type" | "uid" | "selectedSecuritySchemeUids" | "servers" | "selectedServerUid" | "examples" ? R extends import("@scalar/object-utils/nested").Path<{
1480
+ }[P] : P extends `${infer K}.${infer R}` ? K extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "x-codeSamples" | "x-code-samples" | "x-custom-examples" | "x-scalar-stability" | "path" | "method" | "type" | "uid" | "selectedSecuritySchemeUids" | "servers" | "selectedServerUid" | "examples" ? R extends import("@scalar/object-utils/nested").Path<{
1406
1481
  uid: string & import("zod").BRAND<"operation">;
1407
1482
  path: string;
1408
1483
  type: "request";
@@ -1440,6 +1515,21 @@ declare const client: import("vue").Ref<{
1440
1515
  }[] | undefined;
1441
1516
  requestBody?: any;
1442
1517
  responses?: Record<string, any> | undefined;
1518
+ "x-codeSamples"?: {
1519
+ source: string;
1520
+ label?: string | undefined;
1521
+ lang?: string | undefined;
1522
+ }[] | undefined;
1523
+ "x-code-samples"?: {
1524
+ source: string;
1525
+ label?: string | undefined;
1526
+ lang?: string | undefined;
1527
+ }[] | undefined;
1528
+ "x-custom-examples"?: {
1529
+ source: string;
1530
+ label?: string | undefined;
1531
+ lang?: string | undefined;
1532
+ }[] | undefined;
1443
1533
  "x-scalar-stability"?: import("@scalar/types").XScalarStability | undefined;
1444
1534
  }[K]> ? import("@scalar/object-utils/nested").PathValue<{
1445
1535
  uid: string & import("zod").BRAND<"operation">;
@@ -1479,9 +1569,24 @@ declare const client: import("vue").Ref<{
1479
1569
  }[] | undefined;
1480
1570
  requestBody?: any;
1481
1571
  responses?: Record<string, any> | undefined;
1572
+ "x-codeSamples"?: {
1573
+ source: string;
1574
+ label?: string | undefined;
1575
+ lang?: string | undefined;
1576
+ }[] | undefined;
1577
+ "x-code-samples"?: {
1578
+ source: string;
1579
+ label?: string | undefined;
1580
+ lang?: string | undefined;
1581
+ }[] | undefined;
1582
+ "x-custom-examples"?: {
1583
+ source: string;
1584
+ label?: string | undefined;
1585
+ lang?: string | undefined;
1586
+ }[] | undefined;
1482
1587
  "x-scalar-stability"?: import("@scalar/types").XScalarStability | undefined;
1483
1588
  }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
1484
- untrackedEdit: <P extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "x-scalar-stability" | "path" | "method" | "type" | "uid" | "selectedSecuritySchemeUids" | "servers" | "selectedServerUid" | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.description" | "externalDocs.url" | `selectedSecuritySchemeUids.${number}` | `selectedSecuritySchemeUids.${number}.${number}` | `servers.${number}` | "examples" | `requestBody.${string}` | `examples.${number}` | `parameters.${number}` | `parameters.${number}.description` | `parameters.${number}.deprecated` | `parameters.${number}.example` | `parameters.${number}.name` | `parameters.${number}.in` | `parameters.${number}.style` | `parameters.${number}.examples` | `parameters.${number}.content` | `parameters.${number}.required` | `parameters.${number}.schema` | `parameters.${number}.examples.${number}` | `parameters.${number}.examples.${string}` | `responses.${string}`>(uid: string & import("zod").BRAND<"operation">, path: P, value: P extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "x-scalar-stability" | "path" | "method" | "type" | "uid" | "selectedSecuritySchemeUids" | "servers" | "selectedServerUid" | "examples" ? {
1589
+ untrackedEdit: <P extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "x-codeSamples" | "x-code-samples" | "x-custom-examples" | "x-scalar-stability" | "path" | "method" | "type" | "uid" | "selectedSecuritySchemeUids" | "servers" | "selectedServerUid" | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.description" | "externalDocs.url" | `selectedSecuritySchemeUids.${number}` | `selectedSecuritySchemeUids.${number}.${number}` | `servers.${number}` | "examples" | `requestBody.${string}` | `examples.${number}` | `parameters.${number}` | `parameters.${number}.description` | `parameters.${number}.deprecated` | `parameters.${number}.example` | `parameters.${number}.name` | `parameters.${number}.in` | `parameters.${number}.style` | `parameters.${number}.examples` | `parameters.${number}.content` | `parameters.${number}.required` | `parameters.${number}.schema` | `parameters.${number}.examples.${number}` | `parameters.${number}.examples.${string}` | `responses.${string}` | `x-codeSamples.${number}` | `x-codeSamples.${number}.label` | `x-codeSamples.${number}.source` | `x-codeSamples.${number}.lang` | `x-code-samples.${number}` | `x-code-samples.${number}.label` | `x-code-samples.${number}.source` | `x-code-samples.${number}.lang` | `x-custom-examples.${number}` | `x-custom-examples.${number}.label` | `x-custom-examples.${number}.source` | `x-custom-examples.${number}.lang`>(uid: string & import("zod").BRAND<"operation">, path: P, value: P extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "x-codeSamples" | "x-code-samples" | "x-custom-examples" | "x-scalar-stability" | "path" | "method" | "type" | "uid" | "selectedSecuritySchemeUids" | "servers" | "selectedServerUid" | "examples" ? {
1485
1590
  uid: string & import("zod").BRAND<"operation">;
1486
1591
  path: string;
1487
1592
  type: "request";
@@ -1519,8 +1624,23 @@ declare const client: import("vue").Ref<{
1519
1624
  }[] | undefined;
1520
1625
  requestBody?: any;
1521
1626
  responses?: Record<string, any> | undefined;
1627
+ "x-codeSamples"?: {
1628
+ source: string;
1629
+ label?: string | undefined;
1630
+ lang?: string | undefined;
1631
+ }[] | undefined;
1632
+ "x-code-samples"?: {
1633
+ source: string;
1634
+ label?: string | undefined;
1635
+ lang?: string | undefined;
1636
+ }[] | undefined;
1637
+ "x-custom-examples"?: {
1638
+ source: string;
1639
+ label?: string | undefined;
1640
+ lang?: string | undefined;
1641
+ }[] | undefined;
1522
1642
  "x-scalar-stability"?: import("@scalar/types").XScalarStability | undefined;
1523
- }[P] : P extends `${infer K}.${infer R}` ? K extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "x-scalar-stability" | "path" | "method" | "type" | "uid" | "selectedSecuritySchemeUids" | "servers" | "selectedServerUid" | "examples" ? R extends import("@scalar/object-utils/nested").Path<{
1643
+ }[P] : P extends `${infer K}.${infer R}` ? K extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "x-codeSamples" | "x-code-samples" | "x-custom-examples" | "x-scalar-stability" | "path" | "method" | "type" | "uid" | "selectedSecuritySchemeUids" | "servers" | "selectedServerUid" | "examples" ? R extends import("@scalar/object-utils/nested").Path<{
1524
1644
  uid: string & import("zod").BRAND<"operation">;
1525
1645
  path: string;
1526
1646
  type: "request";
@@ -1558,6 +1678,21 @@ declare const client: import("vue").Ref<{
1558
1678
  }[] | undefined;
1559
1679
  requestBody?: any;
1560
1680
  responses?: Record<string, any> | undefined;
1681
+ "x-codeSamples"?: {
1682
+ source: string;
1683
+ label?: string | undefined;
1684
+ lang?: string | undefined;
1685
+ }[] | undefined;
1686
+ "x-code-samples"?: {
1687
+ source: string;
1688
+ label?: string | undefined;
1689
+ lang?: string | undefined;
1690
+ }[] | undefined;
1691
+ "x-custom-examples"?: {
1692
+ source: string;
1693
+ label?: string | undefined;
1694
+ lang?: string | undefined;
1695
+ }[] | undefined;
1561
1696
  "x-scalar-stability"?: import("@scalar/types").XScalarStability | undefined;
1562
1697
  }[K]> ? import("@scalar/object-utils/nested").PathValue<{
1563
1698
  uid: string & import("zod").BRAND<"operation">;
@@ -1597,6 +1732,21 @@ declare const client: import("vue").Ref<{
1597
1732
  }[] | undefined;
1598
1733
  requestBody?: any;
1599
1734
  responses?: Record<string, any> | undefined;
1735
+ "x-codeSamples"?: {
1736
+ source: string;
1737
+ label?: string | undefined;
1738
+ lang?: string | undefined;
1739
+ }[] | undefined;
1740
+ "x-code-samples"?: {
1741
+ source: string;
1742
+ label?: string | undefined;
1743
+ lang?: string | undefined;
1744
+ }[] | undefined;
1745
+ "x-custom-examples"?: {
1746
+ source: string;
1747
+ label?: string | undefined;
1748
+ lang?: string | undefined;
1749
+ }[] | undefined;
1600
1750
  "x-scalar-stability"?: import("@scalar/types").XScalarStability | undefined;
1601
1751
  }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
1602
1752
  undo: (uid: string & import("zod").BRAND<"operation">) => void;
@@ -3843,6 +3993,21 @@ declare const client: import("vue").Ref<{
3843
3993
  }[] | undefined;
3844
3994
  requestBody?: any;
3845
3995
  responses?: Record<string, any> | undefined;
3996
+ "x-codeSamples"?: {
3997
+ source: string;
3998
+ label?: string | undefined;
3999
+ lang?: string | undefined;
4000
+ }[] | undefined;
4001
+ "x-code-samples"?: {
4002
+ source: string;
4003
+ label?: string | undefined;
4004
+ lang?: string | undefined;
4005
+ }[] | undefined;
4006
+ "x-custom-examples"?: {
4007
+ source: string;
4008
+ label?: string | undefined;
4009
+ lang?: string | undefined;
4010
+ }[] | undefined;
3846
4011
  "x-scalar-stability"?: import("@scalar/types").XScalarStability | undefined;
3847
4012
  }>;
3848
4013
  collections: Record<string, {
@@ -4847,6 +5012,21 @@ declare const client: import("vue").Ref<{
4847
5012
  }[] | undefined;
4848
5013
  requestBody?: any;
4849
5014
  responses?: Record<string, any> | undefined;
5015
+ "x-codeSamples"?: {
5016
+ source: string;
5017
+ label?: string | undefined;
5018
+ lang?: string | undefined;
5019
+ }[] | undefined;
5020
+ "x-code-samples"?: {
5021
+ source: string;
5022
+ label?: string | undefined;
5023
+ lang?: string | undefined;
5024
+ }[] | undefined;
5025
+ "x-custom-examples"?: {
5026
+ source: string;
5027
+ label?: string | undefined;
5028
+ lang?: string | undefined;
5029
+ }[] | undefined;
4850
5030
  "x-scalar-stability"?: import("@scalar/types").XScalarStability | undefined;
4851
5031
  }) => void;
4852
5032
  add: (payload: import("@scalar/oas-utils/entities/spec").RequestPayload, collectionUid: import("@scalar/oas-utils/entities/spec").Collection["uid"]) => void | {
@@ -4887,6 +5067,21 @@ declare const client: import("vue").Ref<{
4887
5067
  }[] | undefined;
4888
5068
  requestBody?: any;
4889
5069
  responses?: Record<string, any> | undefined;
5070
+ "x-codeSamples"?: {
5071
+ source: string;
5072
+ label?: string | undefined;
5073
+ lang?: string | undefined;
5074
+ }[] | undefined;
5075
+ "x-code-samples"?: {
5076
+ source: string;
5077
+ label?: string | undefined;
5078
+ lang?: string | undefined;
5079
+ }[] | undefined;
5080
+ "x-custom-examples"?: {
5081
+ source: string;
5082
+ label?: string | undefined;
5083
+ lang?: string | undefined;
5084
+ }[] | undefined;
4890
5085
  "x-scalar-stability"?: import("@scalar/types").XScalarStability | undefined;
4891
5086
  };
4892
5087
  delete: (request: import("@scalar/oas-utils/entities/spec").Request, collectionUid: import("@scalar/oas-utils/entities/spec").Collection["uid"]) => void;
@@ -4928,9 +5123,24 @@ declare const client: import("vue").Ref<{
4928
5123
  }[] | undefined;
4929
5124
  requestBody?: any;
4930
5125
  responses?: Record<string, any> | undefined;
5126
+ "x-codeSamples"?: {
5127
+ source: string;
5128
+ label?: string | undefined;
5129
+ lang?: string | undefined;
5130
+ }[] | undefined;
5131
+ "x-code-samples"?: {
5132
+ source: string;
5133
+ label?: string | undefined;
5134
+ lang?: string | undefined;
5135
+ }[] | undefined;
5136
+ "x-custom-examples"?: {
5137
+ source: string;
5138
+ label?: string | undefined;
5139
+ lang?: string | undefined;
5140
+ }[] | undefined;
4931
5141
  "x-scalar-stability"?: import("@scalar/types").XScalarStability | undefined;
4932
5142
  }) => void;
4933
- edit: <P extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "x-scalar-stability" | "path" | "method" | "type" | "uid" | "selectedSecuritySchemeUids" | "servers" | "selectedServerUid" | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.description" | "externalDocs.url" | `selectedSecuritySchemeUids.${number}` | `selectedSecuritySchemeUids.${number}.${number}` | `servers.${number}` | "examples" | `requestBody.${string}` | `examples.${number}` | `parameters.${number}` | `parameters.${number}.description` | `parameters.${number}.deprecated` | `parameters.${number}.example` | `parameters.${number}.name` | `parameters.${number}.in` | `parameters.${number}.style` | `parameters.${number}.examples` | `parameters.${number}.content` | `parameters.${number}.required` | `parameters.${number}.schema` | `parameters.${number}.examples.${number}` | `parameters.${number}.examples.${string}` | `responses.${string}`>(uid: (string & import("zod").BRAND<"operation">) | null | undefined, path: P, value: P extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "x-scalar-stability" | "path" | "method" | "type" | "uid" | "selectedSecuritySchemeUids" | "servers" | "selectedServerUid" | "examples" ? {
5143
+ edit: <P extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "x-codeSamples" | "x-code-samples" | "x-custom-examples" | "x-scalar-stability" | "path" | "method" | "type" | "uid" | "selectedSecuritySchemeUids" | "servers" | "selectedServerUid" | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.description" | "externalDocs.url" | `selectedSecuritySchemeUids.${number}` | `selectedSecuritySchemeUids.${number}.${number}` | `servers.${number}` | "examples" | `requestBody.${string}` | `examples.${number}` | `parameters.${number}` | `parameters.${number}.description` | `parameters.${number}.deprecated` | `parameters.${number}.example` | `parameters.${number}.name` | `parameters.${number}.in` | `parameters.${number}.style` | `parameters.${number}.examples` | `parameters.${number}.content` | `parameters.${number}.required` | `parameters.${number}.schema` | `parameters.${number}.examples.${number}` | `parameters.${number}.examples.${string}` | `responses.${string}` | `x-codeSamples.${number}` | `x-codeSamples.${number}.label` | `x-codeSamples.${number}.source` | `x-codeSamples.${number}.lang` | `x-code-samples.${number}` | `x-code-samples.${number}.label` | `x-code-samples.${number}.source` | `x-code-samples.${number}.lang` | `x-custom-examples.${number}` | `x-custom-examples.${number}.label` | `x-custom-examples.${number}.source` | `x-custom-examples.${number}.lang`>(uid: (string & import("zod").BRAND<"operation">) | null | undefined, path: P, value: P extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "x-codeSamples" | "x-code-samples" | "x-custom-examples" | "x-scalar-stability" | "path" | "method" | "type" | "uid" | "selectedSecuritySchemeUids" | "servers" | "selectedServerUid" | "examples" ? {
4934
5144
  uid: string & import("zod").BRAND<"operation">;
4935
5145
  path: string;
4936
5146
  type: "request";
@@ -4968,8 +5178,23 @@ declare const client: import("vue").Ref<{
4968
5178
  }[] | undefined;
4969
5179
  requestBody?: any;
4970
5180
  responses?: Record<string, any> | undefined;
5181
+ "x-codeSamples"?: {
5182
+ source: string;
5183
+ label?: string | undefined;
5184
+ lang?: string | undefined;
5185
+ }[] | undefined;
5186
+ "x-code-samples"?: {
5187
+ source: string;
5188
+ label?: string | undefined;
5189
+ lang?: string | undefined;
5190
+ }[] | undefined;
5191
+ "x-custom-examples"?: {
5192
+ source: string;
5193
+ label?: string | undefined;
5194
+ lang?: string | undefined;
5195
+ }[] | undefined;
4971
5196
  "x-scalar-stability"?: import("@scalar/types").XScalarStability | undefined;
4972
- }[P] : P extends `${infer K}.${infer R}` ? K extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "x-scalar-stability" | "path" | "method" | "type" | "uid" | "selectedSecuritySchemeUids" | "servers" | "selectedServerUid" | "examples" ? R extends import("@scalar/object-utils/nested").Path<{
5197
+ }[P] : P extends `${infer K}.${infer R}` ? K extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "x-codeSamples" | "x-code-samples" | "x-custom-examples" | "x-scalar-stability" | "path" | "method" | "type" | "uid" | "selectedSecuritySchemeUids" | "servers" | "selectedServerUid" | "examples" ? R extends import("@scalar/object-utils/nested").Path<{
4973
5198
  uid: string & import("zod").BRAND<"operation">;
4974
5199
  path: string;
4975
5200
  type: "request";
@@ -5007,6 +5232,21 @@ declare const client: import("vue").Ref<{
5007
5232
  }[] | undefined;
5008
5233
  requestBody?: any;
5009
5234
  responses?: Record<string, any> | undefined;
5235
+ "x-codeSamples"?: {
5236
+ source: string;
5237
+ label?: string | undefined;
5238
+ lang?: string | undefined;
5239
+ }[] | undefined;
5240
+ "x-code-samples"?: {
5241
+ source: string;
5242
+ label?: string | undefined;
5243
+ lang?: string | undefined;
5244
+ }[] | undefined;
5245
+ "x-custom-examples"?: {
5246
+ source: string;
5247
+ label?: string | undefined;
5248
+ lang?: string | undefined;
5249
+ }[] | undefined;
5010
5250
  "x-scalar-stability"?: import("@scalar/types").XScalarStability | undefined;
5011
5251
  }[K]> ? import("@scalar/object-utils/nested").PathValue<{
5012
5252
  uid: string & import("zod").BRAND<"operation">;
@@ -5046,9 +5286,24 @@ declare const client: import("vue").Ref<{
5046
5286
  }[] | undefined;
5047
5287
  requestBody?: any;
5048
5288
  responses?: Record<string, any> | undefined;
5289
+ "x-codeSamples"?: {
5290
+ source: string;
5291
+ label?: string | undefined;
5292
+ lang?: string | undefined;
5293
+ }[] | undefined;
5294
+ "x-code-samples"?: {
5295
+ source: string;
5296
+ label?: string | undefined;
5297
+ lang?: string | undefined;
5298
+ }[] | undefined;
5299
+ "x-custom-examples"?: {
5300
+ source: string;
5301
+ label?: string | undefined;
5302
+ lang?: string | undefined;
5303
+ }[] | undefined;
5049
5304
  "x-scalar-stability"?: import("@scalar/types").XScalarStability | undefined;
5050
5305
  }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
5051
- untrackedEdit: <P extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "x-scalar-stability" | "path" | "method" | "type" | "uid" | "selectedSecuritySchemeUids" | "servers" | "selectedServerUid" | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.description" | "externalDocs.url" | `selectedSecuritySchemeUids.${number}` | `selectedSecuritySchemeUids.${number}.${number}` | `servers.${number}` | "examples" | `requestBody.${string}` | `examples.${number}` | `parameters.${number}` | `parameters.${number}.description` | `parameters.${number}.deprecated` | `parameters.${number}.example` | `parameters.${number}.name` | `parameters.${number}.in` | `parameters.${number}.style` | `parameters.${number}.examples` | `parameters.${number}.content` | `parameters.${number}.required` | `parameters.${number}.schema` | `parameters.${number}.examples.${number}` | `parameters.${number}.examples.${string}` | `responses.${string}`>(uid: string & import("zod").BRAND<"operation">, path: P, value: P extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "x-scalar-stability" | "path" | "method" | "type" | "uid" | "selectedSecuritySchemeUids" | "servers" | "selectedServerUid" | "examples" ? {
5306
+ untrackedEdit: <P extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "x-codeSamples" | "x-code-samples" | "x-custom-examples" | "x-scalar-stability" | "path" | "method" | "type" | "uid" | "selectedSecuritySchemeUids" | "servers" | "selectedServerUid" | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.description" | "externalDocs.url" | `selectedSecuritySchemeUids.${number}` | `selectedSecuritySchemeUids.${number}.${number}` | `servers.${number}` | "examples" | `requestBody.${string}` | `examples.${number}` | `parameters.${number}` | `parameters.${number}.description` | `parameters.${number}.deprecated` | `parameters.${number}.example` | `parameters.${number}.name` | `parameters.${number}.in` | `parameters.${number}.style` | `parameters.${number}.examples` | `parameters.${number}.content` | `parameters.${number}.required` | `parameters.${number}.schema` | `parameters.${number}.examples.${number}` | `parameters.${number}.examples.${string}` | `responses.${string}` | `x-codeSamples.${number}` | `x-codeSamples.${number}.label` | `x-codeSamples.${number}.source` | `x-codeSamples.${number}.lang` | `x-code-samples.${number}` | `x-code-samples.${number}.label` | `x-code-samples.${number}.source` | `x-code-samples.${number}.lang` | `x-custom-examples.${number}` | `x-custom-examples.${number}.label` | `x-custom-examples.${number}.source` | `x-custom-examples.${number}.lang`>(uid: string & import("zod").BRAND<"operation">, path: P, value: P extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "x-codeSamples" | "x-code-samples" | "x-custom-examples" | "x-scalar-stability" | "path" | "method" | "type" | "uid" | "selectedSecuritySchemeUids" | "servers" | "selectedServerUid" | "examples" ? {
5052
5307
  uid: string & import("zod").BRAND<"operation">;
5053
5308
  path: string;
5054
5309
  type: "request";
@@ -5086,8 +5341,23 @@ declare const client: import("vue").Ref<{
5086
5341
  }[] | undefined;
5087
5342
  requestBody?: any;
5088
5343
  responses?: Record<string, any> | undefined;
5344
+ "x-codeSamples"?: {
5345
+ source: string;
5346
+ label?: string | undefined;
5347
+ lang?: string | undefined;
5348
+ }[] | undefined;
5349
+ "x-code-samples"?: {
5350
+ source: string;
5351
+ label?: string | undefined;
5352
+ lang?: string | undefined;
5353
+ }[] | undefined;
5354
+ "x-custom-examples"?: {
5355
+ source: string;
5356
+ label?: string | undefined;
5357
+ lang?: string | undefined;
5358
+ }[] | undefined;
5089
5359
  "x-scalar-stability"?: import("@scalar/types").XScalarStability | undefined;
5090
- }[P] : P extends `${infer K}.${infer R}` ? K extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "x-scalar-stability" | "path" | "method" | "type" | "uid" | "selectedSecuritySchemeUids" | "servers" | "selectedServerUid" | "examples" ? R extends import("@scalar/object-utils/nested").Path<{
5360
+ }[P] : P extends `${infer K}.${infer R}` ? K extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "x-codeSamples" | "x-code-samples" | "x-custom-examples" | "x-scalar-stability" | "path" | "method" | "type" | "uid" | "selectedSecuritySchemeUids" | "servers" | "selectedServerUid" | "examples" ? R extends import("@scalar/object-utils/nested").Path<{
5091
5361
  uid: string & import("zod").BRAND<"operation">;
5092
5362
  path: string;
5093
5363
  type: "request";
@@ -5125,6 +5395,21 @@ declare const client: import("vue").Ref<{
5125
5395
  }[] | undefined;
5126
5396
  requestBody?: any;
5127
5397
  responses?: Record<string, any> | undefined;
5398
+ "x-codeSamples"?: {
5399
+ source: string;
5400
+ label?: string | undefined;
5401
+ lang?: string | undefined;
5402
+ }[] | undefined;
5403
+ "x-code-samples"?: {
5404
+ source: string;
5405
+ label?: string | undefined;
5406
+ lang?: string | undefined;
5407
+ }[] | undefined;
5408
+ "x-custom-examples"?: {
5409
+ source: string;
5410
+ label?: string | undefined;
5411
+ lang?: string | undefined;
5412
+ }[] | undefined;
5128
5413
  "x-scalar-stability"?: import("@scalar/types").XScalarStability | undefined;
5129
5414
  }[K]> ? import("@scalar/object-utils/nested").PathValue<{
5130
5415
  uid: string & import("zod").BRAND<"operation">;
@@ -5164,6 +5449,21 @@ declare const client: import("vue").Ref<{
5164
5449
  }[] | undefined;
5165
5450
  requestBody?: any;
5166
5451
  responses?: Record<string, any> | undefined;
5452
+ "x-codeSamples"?: {
5453
+ source: string;
5454
+ label?: string | undefined;
5455
+ lang?: string | undefined;
5456
+ }[] | undefined;
5457
+ "x-code-samples"?: {
5458
+ source: string;
5459
+ label?: string | undefined;
5460
+ lang?: string | undefined;
5461
+ }[] | undefined;
5462
+ "x-custom-examples"?: {
5463
+ source: string;
5464
+ label?: string | undefined;
5465
+ lang?: string | undefined;
5466
+ }[] | undefined;
5167
5467
  "x-scalar-stability"?: import("@scalar/types").XScalarStability | undefined;
5168
5468
  }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
5169
5469
  undo: (uid: string & import("zod").BRAND<"operation">) => void;