@scalar/workspace-store 0.56.0 → 0.57.0

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 (128) hide show
  1. package/CHANGELOG.md +29 -0
  2. package/dist/client.d.ts.map +1 -1
  3. package/dist/client.js +9 -0
  4. package/dist/entities/auth/schema.d.ts +220 -20
  5. package/dist/entities/auth/schema.d.ts.map +1 -1
  6. package/dist/mutators/operation/helpers/fetch-request-to-har.d.ts.map +1 -1
  7. package/dist/mutators/operation/helpers/fetch-request-to-har.js +7 -2
  8. package/dist/navigation/get-navigation-options.d.ts.map +1 -1
  9. package/dist/navigation/get-navigation-options.js +4 -1
  10. package/dist/request-example/builder/body/get-request-body-example.d.ts.map +1 -1
  11. package/dist/request-example/builder/body/get-request-body-example.js +4 -2
  12. package/dist/schemas/reference-config/index.d.ts +28 -4
  13. package/dist/schemas/reference-config/index.d.ts.map +1 -1
  14. package/dist/schemas/reference-config/settings.d.ts +28 -4
  15. package/dist/schemas/reference-config/settings.d.ts.map +1 -1
  16. package/dist/schemas/v3.1/strict/oauth-flow.d.ts +19 -1
  17. package/dist/schemas/v3.1/strict/oauth-flow.d.ts.map +1 -1
  18. package/dist/schemas/v3.1/strict/oauth-flow.js +6 -1
  19. package/dist/schemas/v3.1/strict/oauthflows.d.ts +16 -0
  20. package/dist/schemas/v3.1/strict/oauthflows.d.ts.map +1 -1
  21. package/dist/schemas/v3.1/strict/openapi-document.d.ts +980 -140
  22. package/dist/schemas/v3.1/strict/openapi-document.d.ts.map +1 -1
  23. package/dist/schemas/v3.1/strict/security-scheme.d.ts +14 -5
  24. package/dist/schemas/v3.1/strict/security-scheme.d.ts.map +1 -1
  25. package/dist/schemas/v3.1/strict/security-scheme.js +5 -2
  26. package/dist/schemas/v3.2/openapi/index.d.ts +144 -0
  27. package/dist/schemas/v3.2/openapi/index.d.ts.map +1 -0
  28. package/dist/schemas/v3.2/openapi/index.js +713 -0
  29. package/dist/schemas/v3.2/openapi/reference.d.ts +4 -0
  30. package/dist/schemas/v3.2/openapi/reference.d.ts.map +1 -0
  31. package/dist/schemas/v3.2/openapi/reference.js +29 -0
  32. package/dist/schemas/v3.2/strict/callback.d.ts +15 -0
  33. package/dist/schemas/v3.2/strict/callback.d.ts.map +1 -0
  34. package/dist/schemas/v3.2/strict/callback.js +6 -0
  35. package/dist/schemas/v3.2/strict/components.d.ts +173 -0
  36. package/dist/schemas/v3.2/strict/components.d.ts.map +1 -0
  37. package/dist/schemas/v3.2/strict/components.js +29 -0
  38. package/dist/schemas/v3.2/strict/contact.d.ts +19 -0
  39. package/dist/schemas/v3.2/strict/contact.d.ts.map +1 -0
  40. package/dist/schemas/v3.2/strict/contact.js +10 -0
  41. package/dist/schemas/v3.2/strict/discriminator.d.ts +27 -0
  42. package/dist/schemas/v3.2/strict/discriminator.d.ts.map +1 -0
  43. package/dist/schemas/v3.2/strict/discriminator.js +14 -0
  44. package/dist/schemas/v3.2/strict/encoding.d.ts +62 -0
  45. package/dist/schemas/v3.2/strict/encoding.d.ts.map +1 -0
  46. package/dist/schemas/v3.2/strict/encoding.js +33 -0
  47. package/dist/schemas/v3.2/strict/example.d.ts +50 -0
  48. package/dist/schemas/v3.2/strict/example.d.ts.map +1 -0
  49. package/dist/schemas/v3.2/strict/example.js +22 -0
  50. package/dist/schemas/v3.2/strict/external-documentation.d.ts +15 -0
  51. package/dist/schemas/v3.2/strict/external-documentation.d.ts.map +1 -0
  52. package/dist/schemas/v3.2/strict/external-documentation.js +8 -0
  53. package/dist/schemas/v3.2/strict/header.d.ts +97 -0
  54. package/dist/schemas/v3.2/strict/header.d.ts.map +1 -0
  55. package/dist/schemas/v3.2/strict/header.js +39 -0
  56. package/dist/schemas/v3.2/strict/info.d.ts +54 -0
  57. package/dist/schemas/v3.2/strict/info.d.ts.map +1 -0
  58. package/dist/schemas/v3.2/strict/info.js +24 -0
  59. package/dist/schemas/v3.2/strict/license.d.ts +19 -0
  60. package/dist/schemas/v3.2/strict/license.d.ts.map +1 -0
  61. package/dist/schemas/v3.2/strict/license.js +10 -0
  62. package/dist/schemas/v3.2/strict/link.d.ts +44 -0
  63. package/dist/schemas/v3.2/strict/link.d.ts.map +1 -0
  64. package/dist/schemas/v3.2/strict/link.js +23 -0
  65. package/dist/schemas/v3.2/strict/media-type.d.ts +78 -0
  66. package/dist/schemas/v3.2/strict/media-type.d.ts.map +1 -0
  67. package/dist/schemas/v3.2/strict/media-type.js +26 -0
  68. package/dist/schemas/v3.2/strict/oauth-flow.d.ts +159 -0
  69. package/dist/schemas/v3.2/strict/oauth-flow.d.ts.map +1 -0
  70. package/dist/schemas/v3.2/strict/oauth-flow.js +44 -0
  71. package/dist/schemas/v3.2/strict/oauthflows.d.ts +116 -0
  72. package/dist/schemas/v3.2/strict/oauthflows.d.ts.map +1 -0
  73. package/dist/schemas/v3.2/strict/oauthflows.js +17 -0
  74. package/dist/schemas/v3.2/strict/openapi-document.d.ts +64576 -0
  75. package/dist/schemas/v3.2/strict/openapi-document.d.ts.map +1 -0
  76. package/dist/schemas/v3.2/strict/openapi-document.js +154 -0
  77. package/dist/schemas/v3.2/strict/operation.d.ts +165 -0
  78. package/dist/schemas/v3.2/strict/operation.d.ts.map +1 -0
  79. package/dist/schemas/v3.2/strict/operation.js +40 -0
  80. package/dist/schemas/v3.2/strict/parameter.d.ts +142 -0
  81. package/dist/schemas/v3.2/strict/parameter.d.ts.map +1 -0
  82. package/dist/schemas/v3.2/strict/parameter.js +58 -0
  83. package/dist/schemas/v3.2/strict/path-item.d.ts +189 -0
  84. package/dist/schemas/v3.2/strict/path-item.d.ts.map +1 -0
  85. package/dist/schemas/v3.2/strict/path-item.js +41 -0
  86. package/dist/schemas/v3.2/strict/paths.d.ts +20 -0
  87. package/dist/schemas/v3.2/strict/paths.d.ts.map +1 -0
  88. package/dist/schemas/v3.2/strict/paths.js +9 -0
  89. package/dist/schemas/v3.2/strict/ref-definitions.d.ts +76 -0
  90. package/dist/schemas/v3.2/strict/ref-definitions.d.ts.map +1 -0
  91. package/dist/schemas/v3.2/strict/ref-definitions.js +80 -0
  92. package/dist/schemas/v3.2/strict/reference.d.ts +63 -0
  93. package/dist/schemas/v3.2/strict/reference.d.ts.map +1 -0
  94. package/dist/schemas/v3.2/strict/reference.js +23 -0
  95. package/dist/schemas/v3.2/strict/request-body.d.ts +23 -0
  96. package/dist/schemas/v3.2/strict/request-body.d.ts.map +1 -0
  97. package/dist/schemas/v3.2/strict/request-body.js +13 -0
  98. package/dist/schemas/v3.2/strict/response.d.ts +50 -0
  99. package/dist/schemas/v3.2/strict/response.d.ts.map +1 -0
  100. package/dist/schemas/v3.2/strict/response.js +15 -0
  101. package/dist/schemas/v3.2/strict/responses.d.ts +32 -0
  102. package/dist/schemas/v3.2/strict/responses.d.ts.map +1 -0
  103. package/dist/schemas/v3.2/strict/responses.js +13 -0
  104. package/dist/schemas/v3.2/strict/schema.d.ts +1330 -0
  105. package/dist/schemas/v3.2/strict/schema.d.ts.map +1 -0
  106. package/dist/schemas/v3.2/strict/schema.js +205 -0
  107. package/dist/schemas/v3.2/strict/security-requirement.d.ts +23 -0
  108. package/dist/schemas/v3.2/strict/security-requirement.d.ts.map +1 -0
  109. package/dist/schemas/v3.2/strict/security-requirement.js +13 -0
  110. package/dist/schemas/v3.2/strict/security-scheme.d.ts +95 -0
  111. package/dist/schemas/v3.2/strict/security-scheme.d.ts.map +1 -0
  112. package/dist/schemas/v3.2/strict/security-scheme.js +46 -0
  113. package/dist/schemas/v3.2/strict/server-variable.d.ts +19 -0
  114. package/dist/schemas/v3.2/strict/server-variable.d.ts.map +1 -0
  115. package/dist/schemas/v3.2/strict/server-variable.js +10 -0
  116. package/dist/schemas/v3.2/strict/server.d.ts +24 -0
  117. package/dist/schemas/v3.2/strict/server.d.ts.map +1 -0
  118. package/dist/schemas/v3.2/strict/server.js +13 -0
  119. package/dist/schemas/v3.2/strict/tag.d.ts +44 -0
  120. package/dist/schemas/v3.2/strict/tag.d.ts.map +1 -0
  121. package/dist/schemas/v3.2/strict/tag.js +22 -0
  122. package/dist/schemas/v3.2/strict/type-guards.d.ts +24 -0
  123. package/dist/schemas/v3.2/strict/type-guards.d.ts.map +1 -0
  124. package/dist/schemas/v3.2/strict/type-guards.js +25 -0
  125. package/dist/schemas/v3.2/strict/xml.d.ts +39 -0
  126. package/dist/schemas/v3.2/strict/xml.d.ts.map +1 -0
  127. package/dist/schemas/v3.2/strict/xml.js +26 -0
  128. package/package.json +12 -12
@@ -0,0 +1 @@
1
+ {"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../../../../src/schemas/v3.2/strict/schema.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,KAAK,SAAS,EAAmB,MAAM,0CAA0C,CAAA;AAC1F,OAAO,EAAE,KAAK,aAAa,EAAuB,MAAM,+CAA+C,CAAA;AACvG,OAAO,EAAE,KAAK,KAAK,EAAe,MAAM,sCAAsC,CAAA;AAC9E,OAAO,EACL,KAAK,yBAAyB,EAE/B,MAAM,0DAA0D,CAAA;AACjE,OAAO,EAAE,KAAK,iBAAiB,EAA2B,MAAM,iDAAiD,CAAA;AACjH,OAAO,EAAE,KAAK,aAAa,EAAuB,MAAM,6CAA6C,CAAA;AACrG,OAAO,EAAE,KAAK,SAAS,EAAmB,MAAM,wCAAwC,CAAA;AACxF,OAAO,EAAE,KAAK,MAAM,EAAgB,MAAM,qCAAqC,CAAA;AAC/E,OAAO,EAAE,KAAK,SAAS,EAAmB,MAAM,wCAAwC,CAAA;AACxF,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,8CAA8C,CAAA;AAC/F,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAA;AAE1D,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAA;AAO1D,OAAO,EAAE,KAAK,eAAe,EAAyB,MAAM,aAAa,CAAA;AAEzE,MAAM,MAAM,mBAAmB,CAAC,KAAK,IAAI,KAAK,GAAG,CAAC,eAAe,GAAG;IAAE,YAAY,CAAC,EAAE,OAAO,CAAA;CAAE,CAAC,CAAA;AAgC/F,KAAK,mBAAmB,GAAG,MAAM,GAAG,SAAS,GAAG,QAAQ,GAAG,QAAQ,GAAG,SAAS,GAAG,QAAQ,GAAG,OAAO,CAAA;AAEpG,uGAAuG;AACvG,KAAK,aAAa,GAAG,cAAc,GAAG;IACpC,SAAS,EAAE,MAAM,CAAA;CAClB,GAAG,UAAU,CAAA;AAEd;;;;GAIG;AACH,QAAA,MAAM,UAAU;;EAEd,CAAA;AAEF,KAAK,SAAS,GAAG,SAAS,GAAG,MAAM,CAAA;AAEnC,KAAK,UAAU,GAAG,cAAc,GAAG;IACjC,IAAI,EAAE,SAAS,CAAA;CAChB,GAAG,UAAU,CAAA;AAEd,QAAA,MAAM,UAAU;;;;;;;;;;;;;;;;;;;;IAUf,CAAA;AAED,KAAK,UAAU,GAAG,aAAa,GAC7B,SAAS,GACT,SAAS,GACT,iBAAiB,GACjB,aAAa,GACb,SAAS,GACT,yBAAyB,GACzB,MAAM,GACN,KAAK,CAAA;AAqEP,KAAK,cAAc,GAAG;IACpB;;;;;;;;OAQG;IACH,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,yEAAyE;IACzE,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,gGAAgG;IAChG,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,wGAAwG;IACxG,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,8BAA8B;IAC9B,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,mCAAmC;IACnC,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,oCAAoC;IACpC,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,+BAA+B;IAC/B,IAAI,CAAC,EAAE,OAAO,EAAE,CAAA;IAChB,8CAA8C;IAC9C,KAAK,CAAC,EAAE,OAAO,CAAA;IACf,yCAAyC;IACzC,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,wBAAwB;IACxB,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB,qCAAqC;IACrC,aAAa,CAAC,EAAE,mBAAmB,CAAC,YAAY,CAAC,CAAA;IACjD,wCAAwC;IACxC,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,0LAA0L;IAC1L,aAAa,CAAC,EAAE,mBAAmB,CAAA;IACnC,uCAAuC;IACvC,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,wCAAwC;IACxC,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB,iKAAiK;IACjK,GAAG,CAAC,EAAE,SAAS,CAAA;IACf,yDAAyD;IACzD,YAAY,CAAC,EAAE,2BAA2B,CAAA;IAC1C;;;;OAIG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,EAAE,CAAA;IACpB,iCAAiC;IACjC,KAAK,CAAC,EAAE,mBAAmB,CAAC,YAAY,CAAC,EAAE,CAAA;IAC3C,wCAAwC;IACxC,KAAK,CAAC,EAAE,mBAAmB,CAAC,YAAY,CAAC,EAAE,CAAA;IAC3C,yCAAyC;IACzC,KAAK,CAAC,EAAE,mBAAmB,CAAC,YAAY,CAAC,EAAE,CAAA;IAC3C,gCAAgC;IAChC,GAAG,CAAC,EAAE,mBAAmB,CAAC,YAAY,CAAC,CAAA;CACxC,CAAA;AA2BD,KAAK,eAAe,GAAG;IACrB,+CAA+C;IAC/C,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,iCAAiC;IACjC,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,iCAAiC;IACjC,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,iCAAiC;IACjC,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,iCAAiC;IACjC,gBAAgB,CAAC,EAAE,MAAM,CAAA;CAC1B,CAAA;AAED,KAAK,aAAa,GACd,MAAM,GACN,OAAO,GACP,OAAO,GACP,OAAO,GACP,OAAO,GACP,QAAQ,GACR,QAAQ,GACR,QAAQ,GACR,YAAY,GACZ,OAAO,GACP,QAAQ,GACR,SAAS,GACT,YAAY,GACZ,YAAY,GACZ,YAAY,GACZ,CAAC,MAAM,GAAG,EAAE,CAAC,CAAA;AAEjB,KAAK,aAAa,GAAG,cAAc,GACjC,eAAe,GAAG;IAChB,IAAI,EAAE,QAAQ,GAAG,SAAS,CAAA;IAC1B,yBAAyB;IACzB,MAAM,CAAC,EAAE,aAAa,CAAA;CACvB,GAAG,UAAU,CAAA;AAuBhB;;;;;GAKG;AACH,KAAK,YAAY,GAEb,MAAM,GACN,WAAW,GACX,iBAAiB,GACjB,MAAM,GACN,YAAY,GACZ,UAAU,GACV,WAAW,GAEX,OAAO,GACP,WAAW,GACX,UAAU,GACV,cAAc,GACd,MAAM,GACN,MAAM,GACN,KAAK,GACL,eAAe,GACf,cAAc,GACd,KAAK,GACL,eAAe,GACf,MAAM,GAEN,QAAQ,GACR,MAAM,GACN,WAAW,GACX,MAAM,GACN,YAAY,GACZ,UAAU,GACV,OAAO,GACP,cAAc,GACd,uBAAuB,GACvB,aAAa,GAEb,MAAM,GAEN,WAAW,GACX,UAAU,GACV,WAAW,GACX,YAAY,GACZ,CAAC,MAAM,GAAG,EAAE,CAAC,CAAA;AAEjB,KAAK,cAAc,GAAG;IACpB,6BAA6B;IAC7B,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,6BAA6B;IAC7B,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,kCAAkC;IAClC,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,KAAK,YAAY,GAAG,cAAc,GAChC,cAAc,GAAG;IACf,IAAI,EAAE,QAAQ,CAAA;IACd,iJAAiJ;IACjJ,MAAM,CAAC,EAAE,YAAY,CAAA;CACtB,GAAG,UAAU,CAAA;AAsBhB,KAAK,aAAa,GAAG;IACnB,wCAAwC;IACxC,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,wCAAwC;IACxC,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,0CAA0C;IAC1C,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,8BAA8B;IAC9B,KAAK,CAAC,EAAE,mBAAmB,CAAC,YAAY,CAAC,CAAA;IACzC,mCAAmC;IACnC,WAAW,CAAC,EAAE,mBAAmB,CAAC,YAAY,CAAC,EAAE,CAAA;CAClD,CAAA;AAED,KAAK,WAAW,GAAG,cAAc,GAC/B,aAAa,GAAG;IACd,IAAI,EAAE,OAAO,CAAA;CACd,GAAG,UAAU,CAAA;AA0BhB,KAAK,cAAc,GAAG;IACpB,oCAAoC;IACpC,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,oCAAoC;IACpC,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,wCAAwC;IACxC,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAA;IACnB,mCAAmC;IACnC,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,YAAY,CAAC,CAAC,CAAA;IAC9D,wCAAwC;IACxC,oBAAoB,CAAC,EAAE,OAAO,GAAG,mBAAmB,CAAC,YAAY,CAAC,CAAA;IAClE,0CAA0C;IAC1C,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,YAAY,CAAC,CAAC,CAAA;IACrE,yEAAyE;IACzE,aAAa,CAAC,EAAE,mBAAmB,CAAC,YAAY,CAAC,CAAA;CAClD,CAAA;AAED,KAAK,YAAY,GAAG,cAAc,GAChC,cAAc,GAAG;IACf,IAAI,EAAE,QAAQ,CAAA;CACf,GAAG,UAAU,CAAA;AAchB,KAAK,eAAe,GAAG,cAAc,GACnC,eAAe,GACf,cAAc,GACd,aAAa,GACb,cAAc,GAAG;IACf,IAAI,EAAE,mBAAmB,EAAE,CAAA;IAC3B,iJAAiJ;IACjJ,MAAM,CAAC,EAAE,YAAY,GAAG,aAAa,CAAA;CACtC,GAAG,UAAU,CAAA;AAEhB,yCAAyC;AACzC,eAAO,MAAM,4BAA4B;;;IApYvC;;;;;;;;OAQG;;IAEH,yEAAyE;;IAEzE,gGAAgG;;IAEhG,wGAAwG;;;IAGxG,8BAA8B;;IAE9B,mCAAmC;;IAEnC,oCAAoC;;IAEpC,+BAA+B;;IAE/B,8CAA8C;;IAE9C,yCAAyC;;IAEzC,wBAAwB;;IAExB,qCAAqC;;;;;;;;;;;IAErC,wCAAwC;;IAExC,0LAA0L;;IAE1L,uCAAuC;;IAEvC,wCAAwC;;IAExC,iKAAiK;;IAEjK,yDAAyD;;IAEzD;;;;OAIG;;IAEH;;;OAGG;;IAEH,iCAAiC;;;;;;;;;;;IAEjC,wCAAwC;;;;;;;;;;;IAExC,yCAAyC;;;;;;;;;;;IAEzC,gCAAgC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IA9DhC;;;;;;;;OAQG;;IAEH,yEAAyE;;IAEzE,gGAAgG;;IAEhG,wGAAwG;;;IAGxG,8BAA8B;;IAE9B,mCAAmC;;IAEnC,oCAAoC;;IAEpC,+BAA+B;;IAE/B,8CAA8C;;IAE9C,yCAAyC;;IAEzC,wBAAwB;;IAExB,qCAAqC;;;;;;;;;;;IAErC,wCAAwC;;IAExC,0LAA0L;;IAE1L,uCAAuC;;IAEvC,wCAAwC;;IAExC,iKAAiK;;IAEjK,yDAAyD;;IAEzD;;;;OAIG;;IAEH;;;OAGG;;IAEH,iCAAiC;;;;;;;;;;;IAEjC,wCAAwC;;;;;;;;;;;IAExC,yCAAyC;;;;;;;;;;;IAEzC,gCAAgC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IA0F9B,yBAAyB;;;IAf3B,+CAA+C;;IAE/C,iCAAiC;;IAEjC,iCAAiC;;IAEjC,iCAAiC;;IAEjC,iCAAiC;;;IAjJjC;;;;;;;;OAQG;;IAEH,yEAAyE;;IAEzE,gGAAgG;;IAEhG,wGAAwG;;;IAGxG,8BAA8B;;IAE9B,mCAAmC;;IAEnC,oCAAoC;;IAEpC,+BAA+B;;IAE/B,8CAA8C;;IAE9C,yCAAyC;;IAEzC,wBAAwB;;IAExB,qCAAqC;;;;;;;;;;;IAErC,wCAAwC;;IAExC,0LAA0L;;IAE1L,uCAAuC;;IAEvC,wCAAwC;;IAExC,iKAAiK;;IAEjK,yDAAyD;;IAEzD;;;;OAIG;;IAEH;;;OAGG;;IAEH,iCAAiC;;;;;;;;;;;IAEjC,wCAAwC;;;;;;;;;;;IAExC,yCAAyC;;;;;;;;;;;IAEzC,gCAAgC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAqJ9B,iJAAiJ;;;IAXnJ,6BAA6B;;IAE7B,6BAA6B;;IAE7B,kCAAkC;;;IA5MlC;;;;;;;;OAQG;;IAEH,yEAAyE;;IAEzE,gGAAgG;;IAEhG,wGAAwG;;;IAGxG,8BAA8B;;IAE9B,mCAAmC;;IAEnC,oCAAoC;;IAEpC,+BAA+B;;IAE/B,8CAA8C;;IAE9C,yCAAyC;;IAEzC,wBAAwB;;IAExB,qCAAqC;;;;;;;;;;;IAErC,wCAAwC;;IAExC,0LAA0L;;IAE1L,uCAAuC;;IAEvC,wCAAwC;;IAExC,iKAAiK;;IAEjK,yDAAyD;;IAEzD;;;;OAIG;;IAEH;;;OAGG;;IAEH,iCAAiC;;;;;;;;;;;IAEjC,wCAAwC;;;;;;;;;;;IAExC,yCAAyC;;;;;;;;;;;IAEzC,gCAAgC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAkQhC,oCAAoC;;IAEpC,oCAAoC;;IAEpC,wCAAwC;;IAExC,mCAAmC;;;;;;;;;;;IAEnC,wCAAwC;;;;;;;;;;;IAExC,0CAA0C;;;;;;;;;;;IAE1C,yEAAyE;;;;;;;;;;;;IA5UzE;;;;;;;;OAQG;;IAEH,yEAAyE;;IAEzE,gGAAgG;;IAEhG,wGAAwG;;;IAGxG,8BAA8B;;IAE9B,mCAAmC;;IAEnC,oCAAoC;;IAEpC,+BAA+B;;IAE/B,8CAA8C;;IAE9C,yCAAyC;;IAEzC,wBAAwB;;IAExB,qCAAqC;;;;;;;;;;;IAErC,wCAAwC;;IAExC,0LAA0L;;IAE1L,uCAAuC;;IAEvC,wCAAwC;;IAExC,iKAAiK;;IAEjK,yDAAyD;;IAEzD;;;;OAIG;;IAEH;;;OAGG;;IAEH,iCAAiC;;;;;;;;;;;IAEjC,wCAAwC;;;;;;;;;;;IAExC,yCAAyC;;;;;;;;;;;IAEzC,gCAAgC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IA4NhC,wCAAwC;;IAExC,wCAAwC;;IAExC,0CAA0C;;IAE1C,8BAA8B;;;;;;;;;;;IAE9B,mCAAmC;;;;;;;;;;;;IAlSnC;;;;;;;;OAQG;;IAEH,yEAAyE;;IAEzE,gGAAgG;;IAEhG,wGAAwG;;;IAGxG,8BAA8B;;IAE9B,mCAAmC;;IAEnC,oCAAoC;;IAEpC,+BAA+B;;IAE/B,8CAA8C;;IAE9C,yCAAyC;;IAEzC,wBAAwB;;IAExB,qCAAqC;;;;;;;;;;;IAErC,wCAAwC;;IAExC,0LAA0L;;IAE1L,uCAAuC;;IAEvC,wCAAwC;;IAExC,iKAAiK;;IAEjK,yDAAyD;;IAEzD;;;;OAIG;;IAEH;;;OAGG;;IAEH,iCAAiC;;;;;;;;;;;IAEjC,wCAAwC;;;;;;;;;;;IAExC,yCAAyC;;;;;;;;;;;IAEzC,gCAAgC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAkT9B,iJAAiJ;;;IAvOnJ,+CAA+C;;IAE/C,iCAAiC;;IAEjC,iCAAiC;;IAEjC,iCAAiC;;IAEjC,iCAAiC;;;IAuDjC,6BAA6B;;IAE7B,6BAA6B;;IAE7B,kCAAkC;;;IA8ElC,wCAAwC;;IAExC,wCAAwC;;IAExC,0CAA0C;;IAE1C,8BAA8B;;;;;;;;;;;IAE9B,mCAAmC;;;;;;;;;;;;IA8BnC,oCAAoC;;IAEpC,oCAAoC;;IAEpC,wCAAwC;;IAExC,mCAAmC;;;;;;;;;;;IAEnC,wCAAwC;;;;;;;;;;;IAExC,0CAA0C;;;;;;;;;;;IAE1C,yEAAyE;;;;;;;;;;;;IA5UzE;;;;;;;;OAQG;;IAEH,yEAAyE;;IAEzE,gGAAgG;;IAEhG,wGAAwG;;;IAGxG,8BAA8B;;IAE9B,mCAAmC;;IAEnC,oCAAoC;;IAEpC,+BAA+B;;IAE/B,8CAA8C;;IAE9C,yCAAyC;;IAEzC,wBAAwB;;IAExB,qCAAqC;;;;;;;;;;;IAErC,wCAAwC;;IAExC,0LAA0L;;IAE1L,uCAAuC;;IAEvC,wCAAwC;;IAExC,iKAAiK;;IAEjK,yDAAyD;;IAEzD;;;;OAIG;;IAEH;;;OAGG;;IAEH,iCAAiC;;;;;;;;;;;IAEjC,wCAAwC;;;;;;;;;;;IAExC,yCAAyC;;;;;;;;;;;IAEzC,gCAAgC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAkVhC,CAAA;AAEF,MAAM,MAAM,YAAY,GACpB,aAAa,GACb,UAAU,GACV,eAAe,GACf,aAAa,GACb,YAAY,GACZ,YAAY,GACZ,WAAW,CAAA;AACf,MAAM,MAAM,oBAAoB,GAAG,mBAAmB,CAAC,YAAY,CAAC,CAAA"}
@@ -0,0 +1,205 @@
1
+ import { Type } from '@scalar/typebox';
2
+ import { compose } from '../../../schemas/compose.js';
3
+ import { XInternalSchema } from '../../../schemas/extensions/document/x-internal.js';
4
+ import { XScalarIgnoreSchema } from '../../../schemas/extensions/document/x-scalar-ignore.js';
5
+ import { XTagsSchema } from '../../../schemas/extensions/document/x-tags.js';
6
+ import { XAdditionalPropertiesNameSchema, } from '../../../schemas/extensions/schema/x-additional-properties-name.js';
7
+ import { XEnumDescriptionsSchema } from '../../../schemas/extensions/schema/x-enum-descriptions.js';
8
+ import { XEnumVarNamesSchema } from '../../../schemas/extensions/schema/x-enum-varnames.js';
9
+ import { XExamplesSchema } from '../../../schemas/extensions/schema/x-examples.js';
10
+ import { XOrderSchema } from '../../../schemas/extensions/schema/x-order.js';
11
+ import { XVariableSchema } from '../../../schemas/extensions/schema/x-variable.js';
12
+ import { DiscriminatorObjectRef, ExternalDocumentationObjectRef, SchemaObjectRef, XMLObjectRef, } from './ref-definitions.js';
13
+ import { ReferenceObjectSchema } from './reference.js';
14
+ /**
15
+ * A schema position can hold either a schema object or a reference to one.
16
+ *
17
+ * The reference variant keeps `$ref-value` optional on purpose: an unresolved
18
+ * reference (for example a sparse chunk `$ref` produced by the server store) is
19
+ * just `{ $ref }` with no resolved value yet. If the reference variant required
20
+ * `$ref-value`, such a value would match neither variant, so coercion would fall
21
+ * back to the schema-object variant and silently drop the `$ref`, which breaks
22
+ * lazy chunk resolution. With `$ref-value` optional the `{ $ref }` already matches
23
+ * the reference variant and is preserved unchanged, independent of order.
24
+ *
25
+ * The schema-object variant comes first so that a value matching neither variant
26
+ * (genuinely invalid input, never a reference) falls back to an empty schema
27
+ * object rather than a bogus `{ $ref: '' }` that would read as a real reference.
28
+ */
29
+ const schemaOrReference = Type.Union([
30
+ SchemaObjectRef,
31
+ compose(ReferenceObjectSchema, Type.Object({ '$ref-value': Type.Optional(Type.Unknown()) })),
32
+ ]);
33
+ const PrimitiveSchemaTypeSchema = Type.Union([
34
+ Type.Literal('null'),
35
+ Type.Literal('boolean'),
36
+ Type.Literal('string'),
37
+ Type.Literal('number'),
38
+ Type.Literal('integer'),
39
+ Type.Literal('object'),
40
+ Type.Literal('array'),
41
+ ]);
42
+ /**
43
+ * Primitive types that don't have additional validation properties.
44
+ * These types (null, boolean) can be used
45
+ * without additional validation constraints.
46
+ */
47
+ const OtherTypes = Type.Object({
48
+ type: Type.Union([Type.Literal('null'), Type.Literal('boolean')]),
49
+ });
50
+ const Extensions = compose(XScalarIgnoreSchema, XInternalSchema, XVariableSchema, XExamplesSchema, XEnumDescriptionsSchema, XEnumVarNamesSchema, XAdditionalPropertiesNameSchema, XOrderSchema, XTagsSchema);
51
+ const CorePropertiesWithSchema = Type.Object({
52
+ /**
53
+ * JSON Schema 2020-12 core reference keywords.
54
+ *
55
+ * OpenAPI 3.1 adopts the JSON Schema 2020-12 dialect for Schema Objects, which means a schema may carry an
56
+ * identifier (`$id`), a plain-name anchor (`$anchor`), and the dynamic binding keywords (`$dynamicAnchor` /
57
+ * `$dynamicRef`) used for generic and recursive patterns such as `PaginatedResponse<T>`. We keep these typed so
58
+ * the keywords survive parsing instead of being dropped as unknown properties. Resolution of `$dynamicRef`
59
+ * against the active `$dynamicAnchor` is tracked separately, see https://github.com/scalar/scalar/issues/9414.
60
+ */
61
+ $id: Type.Optional(Type.String()),
62
+ /** Plain-name anchor that other schemas can reference with `#anchor`. */
63
+ $anchor: Type.Optional(Type.String()),
64
+ /** Dynamic anchor, the target a matching `$dynamicRef` resolves to within the dynamic scope. */
65
+ $dynamicAnchor: Type.Optional(Type.String()),
66
+ /** Dynamic reference, resolved against the outermost matching `$dynamicAnchor` in the dynamic scope. */
67
+ $dynamicRef: Type.Optional(Type.String()),
68
+ name: Type.Optional(Type.String()),
69
+ /** A title for the schema. */
70
+ title: Type.Optional(Type.String()),
71
+ /** A description of the schema. */
72
+ description: Type.Optional(Type.String()),
73
+ /** Default value for the schema. */
74
+ default: Type.Optional(Type.Unknown()),
75
+ /** Array of allowed values. */
76
+ enum: Type.Optional(Type.Array(Type.Unknown())),
77
+ /** Constant value that must match exactly. */
78
+ const: Type.Optional(Type.Unknown()),
79
+ /** Media type for content validation. */
80
+ contentMediaType: Type.Optional(Type.String()),
81
+ /** Content encoding. */
82
+ contentEncoding: Type.Optional(Type.String()),
83
+ /** Schema for content validation. */
84
+ contentSchema: Type.Optional(schemaOrReference),
85
+ /** Whether the schema is deprecated. */
86
+ deprecated: Type.Optional(Type.Boolean()),
87
+ /** Adds support for polymorphism. The discriminator is used to determine which of a set of schemas a payload is expected to satisfy. See Composition and Inheritance for more details. */
88
+ discriminator: Type.Optional(DiscriminatorObjectRef),
89
+ /** Whether the schema is read-only. */
90
+ readOnly: Type.Optional(Type.Boolean()),
91
+ /** Whether the schema is write-only. */
92
+ writeOnly: Type.Optional(Type.Boolean()),
93
+ /** This MAY be used only on property schemas. It has no effect on root schemas. Adds additional metadata to describe the XML representation of this property. */
94
+ xml: Type.Optional(XMLObjectRef),
95
+ /** Additional external documentation for this schema. */
96
+ externalDocs: Type.Optional(ExternalDocumentationObjectRef),
97
+ /**
98
+ * A free-form field to include an example of an instance for this schema. To represent examples that cannot be naturally represented in JSON or YAML, a string value can be used to contain the example with escaping where necessary.
99
+ *
100
+ * @deprecated The example field has been deprecated in favor of the JSON Schema examples keyword. Use of example is discouraged, and later versions of this specification may remove it.
101
+ */
102
+ example: Type.Optional(Type.Unknown()),
103
+ /**
104
+ * An array of examples of valid instances for this schema. This keyword follows the JSON Schema Draft 2020-12 specification.
105
+ * Each example should be a valid instance of the schema.
106
+ */
107
+ examples: Type.Optional(Type.Array(Type.Unknown())),
108
+ /** All schemas must be valid. */
109
+ allOf: Type.Optional(Type.Array(schemaOrReference)),
110
+ /** Exactly one schema must be valid. */
111
+ oneOf: Type.Optional(Type.Array(schemaOrReference)),
112
+ /** At least one schema must be valid. */
113
+ anyOf: Type.Optional(Type.Array(schemaOrReference)),
114
+ /** Schema must not be valid. */
115
+ not: Type.Optional(schemaOrReference),
116
+ });
117
+ /**
118
+ * Numeric validation properties for number and integer types.
119
+ */
120
+ const NumericValidationKeywords = Type.Object({
121
+ /** Number must be a multiple of this value. */
122
+ multipleOf: Type.Optional(Type.Number()),
123
+ /** Maximum value (inclusive). */
124
+ maximum: Type.Optional(Type.Number()),
125
+ /** Maximum value (exclusive). */
126
+ exclusiveMaximum: Type.Optional(Type.Number({ minimum: 0 })),
127
+ /** Minimum value (inclusive). */
128
+ minimum: Type.Optional(Type.Number()),
129
+ /** Minimum value (exclusive). */
130
+ exclusiveMinimum: Type.Optional(Type.Number({ minimum: 0 })),
131
+ });
132
+ const NumericProperties = compose(Type.Object({
133
+ type: Type.Union([Type.Literal('number'), Type.Literal('integer')]),
134
+ /** Different subtypes */
135
+ format: Type.Optional(Type.String()),
136
+ }), NumericValidationKeywords);
137
+ /**
138
+ * String validation properties for string types.
139
+ */
140
+ const StringValidationKeywords = Type.Object({
141
+ /** Maximum string length. */
142
+ maxLength: Type.Optional(Type.Integer({ minimum: 0 })),
143
+ /** Minimum string length. */
144
+ minLength: Type.Optional(Type.Integer({ minimum: 0 })),
145
+ /** Regular expression pattern. */
146
+ pattern: Type.Optional(Type.String()),
147
+ });
148
+ const StringValidationProperties = compose(Type.Object({
149
+ type: Type.Literal('string'),
150
+ /** Different subtypes - allow any arbitrary string, this negates the purpose of having a union of formats so we type it in typescript instead */
151
+ format: Type.Optional(Type.String()),
152
+ }), StringValidationKeywords);
153
+ const ArrayValidationKeywordsWithSchema = Type.Object({
154
+ /** Maximum number of items in array. */
155
+ maxItems: Type.Optional(Type.Integer({ minimum: 0 })),
156
+ /** Minimum number of items in array. */
157
+ minItems: Type.Optional(Type.Integer({ minimum: 0 })),
158
+ /** Whether array items must be unique. */
159
+ uniqueItems: Type.Optional(Type.Boolean()),
160
+ /** Schema for array items. */
161
+ items: Type.Optional(schemaOrReference),
162
+ /** Schema for tuple validation. */
163
+ prefixItems: Type.Optional(Type.Array(schemaOrReference)),
164
+ });
165
+ const ArrayValidationPropertiesWithSchema = compose(Type.Object({
166
+ type: Type.Literal('array'),
167
+ }), ArrayValidationKeywordsWithSchema);
168
+ const ObjectValidationKeywordsWithSchema = Type.Object({
169
+ /** Maximum number of properties. */
170
+ maxProperties: Type.Optional(Type.Integer({ minimum: 0 })),
171
+ /** Minimum number of properties. */
172
+ minProperties: Type.Optional(Type.Integer({ minimum: 0 })),
173
+ /** Array of required property names. */
174
+ required: Type.Optional(Type.Array(Type.String())),
175
+ /** Object property definitions. */
176
+ properties: Type.Optional(Type.Record(Type.String(), schemaOrReference)),
177
+ /** Schema for additional properties. */
178
+ additionalProperties: Type.Optional(Type.Union([Type.Boolean(), schemaOrReference])),
179
+ /** Properties matching regex patterns. */
180
+ patternProperties: Type.Optional(Type.Record(Type.String(), schemaOrReference)),
181
+ /** Constraints on property names (JSON Schema propertyNames keyword). */
182
+ propertyNames: Type.Optional(schemaOrReference),
183
+ });
184
+ const ObjectValidationPropertiesWithSchema = compose(Type.Object({
185
+ type: Type.Literal('object'),
186
+ }), ObjectValidationKeywordsWithSchema);
187
+ const MultiTypeValidationPropertiesWithSchema = compose(Type.Object({
188
+ type: Type.Array(PrimitiveSchemaTypeSchema),
189
+ /** Different subtypes - allow any arbitrary string, this negates the purpose of having a union of formats so we type it in typescript instead */
190
+ format: Type.Optional(Type.String()),
191
+ }), NumericValidationKeywords, StringValidationKeywords, ArrayValidationKeywordsWithSchema, ObjectValidationKeywordsWithSchema);
192
+ /** Builds the recursive schema schema */
193
+ export const SchemaObjectSchemaDefinition = Type.Union([
194
+ // Keep compositions first so they get priority when union is evaluated
195
+ // Make sure there is always a required field so not all properties are optional
196
+ // When all properties are optional (1) typescript will not throw any warnings/error and accepts anything
197
+ // even a non resolved ref and (2) it will match any schema so it will not validate the refs correctly
198
+ compose(Type.Object({ __scalar_: Type.String() }), CorePropertiesWithSchema, Extensions),
199
+ compose(OtherTypes, CorePropertiesWithSchema, Extensions),
200
+ compose(NumericProperties, CorePropertiesWithSchema, Extensions),
201
+ compose(StringValidationProperties, CorePropertiesWithSchema, Extensions),
202
+ compose(ObjectValidationPropertiesWithSchema, CorePropertiesWithSchema, Extensions),
203
+ compose(ArrayValidationPropertiesWithSchema, CorePropertiesWithSchema, Extensions),
204
+ compose(MultiTypeValidationPropertiesWithSchema, CorePropertiesWithSchema, Extensions),
205
+ ]);
@@ -0,0 +1,23 @@
1
+ /**
2
+ * Lists the required security schemes to execute this operation. The name used for each property MUST correspond to a security scheme declared in the Security Schemes under the Components Object.
3
+ *
4
+ * A Security Requirement Object MAY refer to multiple security schemes in which case all schemes MUST be satisfied for a request to be authorized. This enables support for scenarios where multiple query parameters or HTTP headers are required to convey security information.
5
+ *
6
+ * When the security field is defined on the OpenAPI Object or Operation Object and contains multiple Security Requirement Objects, only one of the entries in the list needs to be satisfied to authorize the request. This enables support for scenarios where the API allows multiple, independent security schemes.
7
+ *
8
+ * An empty Security Requirement Object ({}) indicates anonymous access is supported.
9
+ */
10
+ export declare const SecurityRequirementObjectSchemaDefinition: import("@scalar/typebox").TObject<{}>;
11
+ /**
12
+ * Lists the required security schemes to execute this operation. The name used for each property MUST correspond to a security scheme declared in the Security Schemes under the Components Object.
13
+ *
14
+ * A Security Requirement Object MAY refer to multiple security schemes in which case all schemes MUST be satisfied for a request to be authorized. This enables support for scenarios where multiple query parameters or HTTP headers are required to convey security information.
15
+ *
16
+ * When the security field is defined on the OpenAPI Object or Operation Object and contains multiple Security Requirement Objects, only one of the entries in the list needs to be satisfied to authorize the request. This enables support for scenarios where the API allows multiple, independent security schemes.
17
+ *
18
+ * The partial allows for an empty Security Requirement Object ({}) to be included.
19
+ */
20
+ export type SecurityRequirementObject = Partial<Record<
21
+ /** Each name MUST correspond to a security scheme which is declared in the Security Schemes under the Components Object. If the security scheme is of type "oauth2" or "openIdConnect", then the value is a list of scope names required for the execution, and the list MAY be empty if authorization does not require a specified scope. For other security scheme types, the array MAY contain a list of role names which are required for the execution, but are not otherwise defined or exchanged in-band. */
22
+ string, string[]>>;
23
+ //# sourceMappingURL=security-requirement.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"security-requirement.d.ts","sourceRoot":"","sources":["../../../../src/schemas/v3.2/strict/security-requirement.ts"],"names":[],"mappings":"AAEA;;;;;;;;GAQG;AACH,eAAO,MAAM,yCAAyC,uCAMrD,CAAA;AAED;;;;;;;;GAQG;AACH,MAAM,MAAM,yBAAyB,GAAG,OAAO,CAC7C,MAAM;AACJ,ofAAof;AACpf,MAAM,EACN,MAAM,EAAE,CACT,CACF,CAAA"}
@@ -0,0 +1,13 @@
1
+ import { Type } from '@scalar/typebox';
2
+ /**
3
+ * Lists the required security schemes to execute this operation. The name used for each property MUST correspond to a security scheme declared in the Security Schemes under the Components Object.
4
+ *
5
+ * A Security Requirement Object MAY refer to multiple security schemes in which case all schemes MUST be satisfied for a request to be authorized. This enables support for scenarios where multiple query parameters or HTTP headers are required to convey security information.
6
+ *
7
+ * When the security field is defined on the OpenAPI Object or Operation Object and contains multiple Security Requirement Objects, only one of the entries in the list needs to be satisfied to authorize the request. This enables support for scenarios where the API allows multiple, independent security schemes.
8
+ *
9
+ * An empty Security Requirement Object ({}) indicates anonymous access is supported.
10
+ */
11
+ export const SecurityRequirementObjectSchemaDefinition = Type.Partial(Type.Record(
12
+ /** Each name MUST correspond to a security scheme which is declared in the Security Schemes under the Components Object. If the security scheme is of type "oauth2" or "openIdConnect", then the value is a list of scope names required for the execution, and the list MAY be empty if authorization does not require a specified scope. For other security scheme types, the array MAY contain a list of role names which are required for the execution, but are not otherwise defined or exchanged in-band. */
13
+ Type.String(), Type.Array(Type.String())));
@@ -0,0 +1,95 @@
1
+ import { type XDefaultScopes } from '../../../schemas/extensions/security/x-default-scopes.js';
2
+ import type { OAuthFlowsObject } from '../../../schemas/v3.2/strict/oauthflows.js';
3
+ type Description = {
4
+ /** A description for security scheme. CommonMark syntax MAY be used for rich text representation. */
5
+ description?: string;
6
+ /** Declares this security scheme to be deprecated. Consumers SHOULD refrain from usage of the declared scheme. Added in OpenAPI 3.2. */
7
+ deprecated?: boolean;
8
+ };
9
+ export type ApiKeyObject = Description & {
10
+ /** REQUIRED. The type of the security scheme. Valid values are "apiKey", "http", "mutualTLS", "oauth2", "openIdConnect". */
11
+ type: 'apiKey';
12
+ /** REQUIRED. The name of the header, query or cookie parameter to be used. */
13
+ name: string;
14
+ /** REQUIRED. The location of the API key. Valid values are "query", "header", or "cookie". */
15
+ in: 'query' | 'header' | 'cookie';
16
+ };
17
+ export type HttpObject = Description & {
18
+ /** REQUIRED. The type of the security scheme. Valid values are "apiKey", "http", "mutualTLS", "oauth2", "openIdConnect". */
19
+ type: 'http';
20
+ /** REQUIRED. The name of the HTTP Authentication scheme to be used in the Authorization header as defined in RFC7235. The values used SHOULD be registered in the IANA Authentication Scheme registry. The value is case-insensitive, as defined in RFC7235. */
21
+ scheme: 'basic' | 'bearer';
22
+ /** A hint to the client to identify how the bearer token is formatted. Bearer tokens are usually generated by an authorization server, so this information is primarily for documentation purposes. */
23
+ bearerFormat?: string;
24
+ };
25
+ export type OAuth2Object = Description & {
26
+ /** REQUIRED. The type of the security scheme. Valid values are "apiKey", "http", "mutualTLS", "oauth2", "openIdConnect". */
27
+ type: 'oauth2';
28
+ /** REQUIRED. An object containing configuration information for the flow types supported. */
29
+ flows: OAuthFlowsObject;
30
+ /** URL to the OAuth2 authorization server metadata (RFC8414). TLS is required. Added in OpenAPI 3.2. */
31
+ oauth2MetadataUrl?: string;
32
+ } & XDefaultScopes;
33
+ export type OpenIdConnectObject = Description & {
34
+ /** REQUIRED. The type of the security scheme. Valid values are "apiKey", "http", "mutualTLS", "oauth2", "openIdConnect". */
35
+ type: 'openIdConnect';
36
+ /** REQUIRED. Well-known URL to discover the [[OpenID-Connect-Discovery]] provider metadata. */
37
+ openIdConnectUrl: string;
38
+ };
39
+ /**
40
+ * Defines a security scheme that can be used by the operations.
41
+ *
42
+ * Supported schemes are HTTP authentication, an API key (either as a header, a cookie parameter or as a query parameter), mutual TLS (use of a client certificate), OAuth2's common flows (implicit, password, client credentials and authorization code) as defined in RFC6749, and [[OpenID-Connect-Core]]. Please note that as of 2020, the implicit flow is about to be deprecated by OAuth 2.0 Security Best Current Practice. Recommended for most use cases is Authorization Code Grant flow with PKCE.
43
+ */
44
+ export declare const SecuritySchemeObjectSchemaDefinition: import("@scalar/typebox").TUnion<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
45
+ /** A description for security scheme. CommonMark syntax MAY be used for rich text representation. */
46
+ description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
47
+ /** Declares this security scheme to be deprecated. Consumers SHOULD refrain from usage of the declared scheme. Added in OpenAPI 3.2. */
48
+ deprecated: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
49
+ }>, import("@scalar/typebox").TObject<{
50
+ /** REQUIRED. The type of the security scheme. Valid values are "apiKey", "http", "mutualTLS", "oauth2", "openIdConnect". */
51
+ type: import("@scalar/typebox").TLiteral<"apiKey">;
52
+ /** REQUIRED. The name of the header, query or cookie parameter to be used. */
53
+ name: import("@scalar/typebox").TString;
54
+ /** REQUIRED. The location of the API key. Valid values are "query", "header", or "cookie". */
55
+ in: import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"query">, import("@scalar/typebox").TLiteral<"header">, import("@scalar/typebox").TLiteral<"cookie">]>;
56
+ }>]>, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
57
+ /** A description for security scheme. CommonMark syntax MAY be used for rich text representation. */
58
+ description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
59
+ /** Declares this security scheme to be deprecated. Consumers SHOULD refrain from usage of the declared scheme. Added in OpenAPI 3.2. */
60
+ deprecated: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
61
+ }>, import("@scalar/typebox").TObject<{
62
+ /** REQUIRED. The type of the security scheme. Valid values are "apiKey", "http", "mutualTLS", "oauth2", "openIdConnect". */
63
+ type: import("@scalar/typebox").TLiteral<"http">;
64
+ /** REQUIRED. The name of the HTTP Authentication scheme to be used in the Authorization header as defined in RFC7235. The values used SHOULD be registered in the IANA Authentication Scheme registry. The value is case-insensitive, as defined in RFC7235. */
65
+ scheme: import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"basic">, import("@scalar/typebox").TLiteral<"bearer">]>;
66
+ /** A hint to the client to identify how the bearer token is formatted. Bearer tokens are usually generated by an authorization server, so this information is primarily for documentation purposes. */
67
+ bearerFormat: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
68
+ }>]>, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
69
+ /** A description for security scheme. CommonMark syntax MAY be used for rich text representation. */
70
+ description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
71
+ /** Declares this security scheme to be deprecated. Consumers SHOULD refrain from usage of the declared scheme. Added in OpenAPI 3.2. */
72
+ deprecated: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
73
+ }>, import("@scalar/typebox").TObject<{
74
+ /** REQUIRED. The type of the security scheme. Valid values are "apiKey", "http", "mutualTLS", "oauth2", "openIdConnect". */
75
+ type: import("@scalar/typebox").TLiteral<"oauth2">;
76
+ /** REQUIRED. An object containing configuration information for the flow types supported. */
77
+ flows: import("@scalar/typebox").TRef<"OAuthFlowsObject">;
78
+ /** URL to the OAuth2 authorization server metadata (RFC8414). TLS is required. Added in OpenAPI 3.2. */
79
+ oauth2MetadataUrl: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
80
+ }>, import("@scalar/typebox").TObject<{
81
+ 'x-default-scopes': import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TString>>;
82
+ }>]>, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
83
+ /** A description for security scheme. CommonMark syntax MAY be used for rich text representation. */
84
+ description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
85
+ /** Declares this security scheme to be deprecated. Consumers SHOULD refrain from usage of the declared scheme. Added in OpenAPI 3.2. */
86
+ deprecated: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
87
+ }>, import("@scalar/typebox").TObject<{
88
+ /** REQUIRED. The type of the security scheme. Valid values are "apiKey", "http", "mutualTLS", "oauth2", "openIdConnect". */
89
+ type: import("@scalar/typebox").TLiteral<"openIdConnect">;
90
+ /** REQUIRED. Well-known URL to discover the [[OpenID-Connect-Discovery]] provider metadata. */
91
+ openIdConnectUrl: import("@scalar/typebox").TString;
92
+ }>]>]>;
93
+ export type SecuritySchemeObject = ApiKeyObject | HttpObject | OAuth2Object | OpenIdConnectObject;
94
+ export {};
95
+ //# sourceMappingURL=security-scheme.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"security-scheme.d.ts","sourceRoot":"","sources":["../../../../src/schemas/v3.2/strict/security-scheme.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,KAAK,cAAc,EAAwB,MAAM,gDAAgD,CAAA;AAC1G,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,kCAAkC,CAAA;AAUxE,KAAK,WAAW,GAAG;IACjB,qGAAqG;IACrG,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,wIAAwI;IACxI,UAAU,CAAC,EAAE,OAAO,CAAA;CACrB,CAAA;AAcD,MAAM,MAAM,YAAY,GAAG,WAAW,GAAG;IACvC,4HAA4H;IAC5H,IAAI,EAAE,QAAQ,CAAA;IACd,8EAA8E;IAC9E,IAAI,EAAE,MAAM,CAAA;IACZ,8FAA8F;IAC9F,EAAE,EAAE,OAAO,GAAG,QAAQ,GAAG,QAAQ,CAAA;CAClC,CAAA;AAcD,MAAM,MAAM,UAAU,GAAG,WAAW,GAAG;IACrC,4HAA4H;IAC5H,IAAI,EAAE,MAAM,CAAA;IACZ,gQAAgQ;IAChQ,MAAM,EAAE,OAAO,GAAG,QAAQ,CAAA;IAC1B,uMAAuM;IACvM,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB,CAAA;AAeD,MAAM,MAAM,YAAY,GAAG,WAAW,GAAG;IACvC,4HAA4H;IAC5H,IAAI,EAAE,QAAQ,CAAA;IACd,6FAA6F;IAC7F,KAAK,EAAE,gBAAgB,CAAA;IACvB,wGAAwG;IACxG,iBAAiB,CAAC,EAAE,MAAM,CAAA;CAC3B,GAAG,cAAc,CAAA;AAYlB,MAAM,MAAM,mBAAmB,GAAG,WAAW,GAAG;IAC9C,4HAA4H;IAC5H,IAAI,EAAE,eAAe,CAAA;IACrB,+FAA+F;IAC/F,gBAAgB,EAAE,MAAM,CAAA;CACzB,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,oCAAoC;IAnG/C,qGAAqG;;IAErG,wIAAwI;;;IActI,4HAA4H;;IAE5H,8EAA8E;;IAE9E,8FAA8F;;;IApBhG,qGAAqG;;IAErG,wIAAwI;;;IAmCtI,4HAA4H;;IAE5H,gQAAgQ;;IAEhQ,uMAAuM;;;IAzCzM,qGAAqG;;IAErG,wIAAwI;;;IAwDtI,4HAA4H;;IAE5H,6FAA6F;;IAE7F,wGAAwG;;;;;IA9D1G,qGAAqG;;IAErG,wIAAwI;;;IA8EtI,4HAA4H;;IAE5H,+FAA+F;;MAiBc,CAAA;AAEjH,MAAM,MAAM,oBAAoB,GAAG,YAAY,GAAG,UAAU,GAAG,YAAY,GAAG,mBAAmB,CAAA"}
@@ -0,0 +1,46 @@
1
+ import { Type } from '@scalar/typebox';
2
+ import { compose } from '../../../schemas/compose.js';
3
+ import { XDefaultScopesSchema } from '../../../schemas/extensions/security/x-default-scopes.js';
4
+ import { OAuthFlowsObjectRef } from '../../../schemas/v3.2/strict/ref-definitions.js';
5
+ const DescriptionSchema = Type.Object({
6
+ /** A description for security scheme. CommonMark syntax MAY be used for rich text representation. */
7
+ description: Type.Optional(Type.String()),
8
+ /** Declares this security scheme to be deprecated. Consumers SHOULD refrain from usage of the declared scheme. Added in OpenAPI 3.2. */
9
+ deprecated: Type.Optional(Type.Boolean()),
10
+ });
11
+ const ApiKeySchema = compose(DescriptionSchema, Type.Object({
12
+ /** REQUIRED. The type of the security scheme. Valid values are "apiKey", "http", "mutualTLS", "oauth2", "openIdConnect". */
13
+ type: Type.Literal('apiKey'),
14
+ /** REQUIRED. The name of the header, query or cookie parameter to be used. */
15
+ name: Type.String(),
16
+ /** REQUIRED. The location of the API key. Valid values are "query", "header", or "cookie". */
17
+ in: Type.Union([Type.Literal('query'), Type.Literal('header'), Type.Literal('cookie')]),
18
+ }));
19
+ const HttpSchema = compose(DescriptionSchema, Type.Object({
20
+ /** REQUIRED. The type of the security scheme. Valid values are "apiKey", "http", "mutualTLS", "oauth2", "openIdConnect". */
21
+ type: Type.Literal('http'),
22
+ /** REQUIRED. The name of the HTTP Authentication scheme to be used in the Authorization header as defined in RFC7235. The values used SHOULD be registered in the IANA Authentication Scheme registry. The value is case-insensitive, as defined in RFC7235. */
23
+ scheme: Type.Union([Type.Literal('basic'), Type.Literal('bearer')]),
24
+ /** A hint to the client to identify how the bearer token is formatted. Bearer tokens are usually generated by an authorization server, so this information is primarily for documentation purposes. */
25
+ bearerFormat: Type.Optional(Type.String()),
26
+ }));
27
+ const OAuth2 = compose(DescriptionSchema, Type.Object({
28
+ /** REQUIRED. The type of the security scheme. Valid values are "apiKey", "http", "mutualTLS", "oauth2", "openIdConnect". */
29
+ type: Type.Literal('oauth2'),
30
+ /** REQUIRED. An object containing configuration information for the flow types supported. */
31
+ flows: OAuthFlowsObjectRef,
32
+ /** URL to the OAuth2 authorization server metadata (RFC8414). TLS is required. Added in OpenAPI 3.2. */
33
+ oauth2MetadataUrl: Type.Optional(Type.String()),
34
+ }), XDefaultScopesSchema);
35
+ const OpenIdConnect = compose(DescriptionSchema, Type.Object({
36
+ /** REQUIRED. The type of the security scheme. Valid values are "apiKey", "http", "mutualTLS", "oauth2", "openIdConnect". */
37
+ type: Type.Literal('openIdConnect'),
38
+ /** REQUIRED. Well-known URL to discover the [[OpenID-Connect-Discovery]] provider metadata. */
39
+ openIdConnectUrl: Type.String(),
40
+ }));
41
+ /**
42
+ * Defines a security scheme that can be used by the operations.
43
+ *
44
+ * Supported schemes are HTTP authentication, an API key (either as a header, a cookie parameter or as a query parameter), mutual TLS (use of a client certificate), OAuth2's common flows (implicit, password, client credentials and authorization code) as defined in RFC6749, and [[OpenID-Connect-Core]]. Please note that as of 2020, the implicit flow is about to be deprecated by OAuth 2.0 Security Best Current Practice. Recommended for most use cases is Authorization Code Grant flow with PKCE.
45
+ */
46
+ export const SecuritySchemeObjectSchemaDefinition = Type.Union([ApiKeySchema, HttpSchema, OAuth2, OpenIdConnect]);
@@ -0,0 +1,19 @@
1
+ /** An object representing a Server Variable for server URL template substitution. */
2
+ export declare const ServerVariableObjectSchemaDefinition: import("@scalar/typebox").TObject<{
3
+ /** An enumeration of string values to be used if the substitution options are from a limited set. The array MUST NOT be empty. */
4
+ enum: import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TString>>;
5
+ /** REQUIRED. The default value to use for substitution, which SHALL be sent if an alternate value is not supplied. If the enum is defined, the value MUST exist in the enum's values. Note that this behavior is different from the Schema Object's default keyword, which documents the receiver's behavior rather than inserting the value into the data. */
6
+ default: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
7
+ /** An optional description for the server variable. CommonMark syntax MAY be used for rich text representation. */
8
+ description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
9
+ }>;
10
+ /** An object representing a Server Variable for server URL template substitution. */
11
+ export type ServerVariableObject = {
12
+ /** An enumeration of string values to be used if the substitution options are from a limited set. The array MUST NOT be empty. */
13
+ enum?: string[];
14
+ /** REQUIRED. The default value to use for substitution, which SHALL be sent if an alternate value is not supplied. If the enum is defined, the value MUST exist in the enum's values. Note that this behavior is different from the Schema Object's default keyword, which documents the receiver's behavior rather than inserting the value into the data. */
15
+ default?: string;
16
+ /** An optional description for the server variable. CommonMark syntax MAY be used for rich text representation. */
17
+ description?: string;
18
+ };
19
+ //# sourceMappingURL=server-variable.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"server-variable.d.ts","sourceRoot":"","sources":["../../../../src/schemas/v3.2/strict/server-variable.ts"],"names":[],"mappings":"AAEA,qFAAqF;AACrF,eAAO,MAAM,oCAAoC;IAC/C,kIAAkI;;IAElI,+VAA+V;;IAE/V,mHAAmH;;EAEnH,CAAA;AAEF,qFAAqF;AACrF,MAAM,MAAM,oBAAoB,GAAG;IACjC,kIAAkI;IAClI,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;IACf,+VAA+V;IAC/V,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,mHAAmH;IACnH,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB,CAAA"}
@@ -0,0 +1,10 @@
1
+ import { Type } from '@scalar/typebox';
2
+ /** An object representing a Server Variable for server URL template substitution. */
3
+ export const ServerVariableObjectSchemaDefinition = Type.Object({
4
+ /** An enumeration of string values to be used if the substitution options are from a limited set. The array MUST NOT be empty. */
5
+ enum: Type.Optional(Type.Array(Type.String())),
6
+ /** REQUIRED. The default value to use for substitution, which SHALL be sent if an alternate value is not supplied. If the enum is defined, the value MUST exist in the enum's values. Note that this behavior is different from the Schema Object's default keyword, which documents the receiver's behavior rather than inserting the value into the data. */
7
+ default: Type.Optional(Type.String()),
8
+ /** An optional description for the server variable. CommonMark syntax MAY be used for rich text representation. */
9
+ description: Type.Optional(Type.String()),
10
+ });
@@ -0,0 +1,24 @@
1
+ import type { ServerVariableObject } from './server-variable.js';
2
+ /** An object representing a Server. */
3
+ export declare const ServerObjectSchemaDefinition: import("@scalar/typebox").TObject<{
4
+ /** REQUIRED. A URL to the target host. This URL supports Server Variables and MAY be relative, to indicate that the host location is relative to the location where the document containing the Server Object is being served. Variable substitutions will be made when a variable is named in {braces}. */
5
+ url: import("@scalar/typebox").TString;
6
+ /** An optional string describing the host designated by the URL. CommonMark syntax MAY be used for rich text representation. */
7
+ description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
8
+ /** An optional unique string to refer to the host designated by the URL. Added in OpenAPI 3.2. */
9
+ name: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
10
+ /** A map between a variable name and its value. The value is used for substitution in the server's URL template. */
11
+ variables: import("@scalar/typebox").TOptional<import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TRef<"ServerVariableObject">>>;
12
+ }>;
13
+ /** An object representing a Server. */
14
+ export type ServerObject = {
15
+ /** REQUIRED. A URL to the target host. This URL supports Server Variables and MAY be relative, to indicate that the host location is relative to the location where the document containing the Server Object is being served. Variable substitutions will be made when a variable is named in {braces}. */
16
+ url: string;
17
+ /** An optional string describing the host designated by the URL. CommonMark syntax MAY be used for rich text representation. */
18
+ description?: string;
19
+ /** An optional unique string to refer to the host designated by the URL. Added in OpenAPI 3.2. */
20
+ name?: string;
21
+ /** A map between a variable name and its value. The value is used for substitution in the server's URL template. */
22
+ variables?: Record<string, ServerVariableObject>;
23
+ };
24
+ //# sourceMappingURL=server.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"server.d.ts","sourceRoot":"","sources":["../../../../src/schemas/v3.2/strict/server.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,mBAAmB,CAAA;AAE7D,uCAAuC;AACvC,eAAO,MAAM,4BAA4B;IACvC,4SAA4S;;IAE5S,gIAAgI;;IAEhI,kGAAkG;;IAElG,oHAAoH;;EAEpH,CAAA;AAEF,uCAAuC;AACvC,MAAM,MAAM,YAAY,GAAG;IACzB,4SAA4S;IAC5S,GAAG,EAAE,MAAM,CAAA;IACX,gIAAgI;IAChI,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,kGAAkG;IAClG,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,oHAAoH;IACpH,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,oBAAoB,CAAC,CAAA;CACjD,CAAA"}
@@ -0,0 +1,13 @@
1
+ import { Type } from '@scalar/typebox';
2
+ import { ServerVariableObjectRef } from './ref-definitions.js';
3
+ /** An object representing a Server. */
4
+ export const ServerObjectSchemaDefinition = Type.Object({
5
+ /** REQUIRED. A URL to the target host. This URL supports Server Variables and MAY be relative, to indicate that the host location is relative to the location where the document containing the Server Object is being served. Variable substitutions will be made when a variable is named in {braces}. */
6
+ url: Type.String(),
7
+ /** An optional string describing the host designated by the URL. CommonMark syntax MAY be used for rich text representation. */
8
+ description: Type.Optional(Type.String()),
9
+ /** An optional unique string to refer to the host designated by the URL. Added in OpenAPI 3.2. */
10
+ name: Type.Optional(Type.String()),
11
+ /** A map between a variable name and its value. The value is used for substitution in the server's URL template. */
12
+ variables: Type.Optional(Type.Record(Type.String(), ServerVariableObjectRef)),
13
+ });
@@ -0,0 +1,44 @@
1
+ import { type XInternal } from '../../../schemas/extensions/document/x-internal.js';
2
+ import { type XScalarIgnore } from '../../../schemas/extensions/document/x-scalar-ignore.js';
3
+ import { type XScalarOrder } from '../../../schemas/extensions/general/x-scalar-order.js';
4
+ import { type XDisplayName } from '../../../schemas/extensions/tag/x-display-name.js';
5
+ import type { ExternalDocumentationObject } from './external-documentation.js';
6
+ /** Adds metadata to a single tag that is used by the Operation Object. It is not mandatory to have a Tag Object per tag defined in the Operation Object instances. */
7
+ export declare const TagObjectSchemaDefinition: import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
8
+ /** REQUIRED. The name of the tag. */
9
+ name: import("@scalar/typebox").TString;
10
+ /** A short summary of the tag, used for display purposes. Added in OpenAPI 3.2. */
11
+ summary: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
12
+ /** A description for the tag. CommonMark syntax MAY be used for rich text representation. */
13
+ description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
14
+ /** Additional external documentation for this tag. */
15
+ externalDocs: import("@scalar/typebox").TOptional<import("@scalar/typebox").TRef<"ExternalDocumentationObject">>;
16
+ /** The name of a tag that this tag is nested under. The named tag MUST exist in the API description, and circular references between parent and child tags MUST NOT be used. Added in OpenAPI 3.2. */
17
+ parent: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
18
+ /** A machine-readable string to categorize what sort of tag it is. Any string value can be used; common uses are nav for Navigation, badge for visible badges, audience for APIs used by different groups. Added in OpenAPI 3.2. */
19
+ kind: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
20
+ }>, import("@scalar/typebox").TObject<{
21
+ 'x-displayName': import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
22
+ }>, import("@scalar/typebox").TObject<{
23
+ 'x-internal': import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
24
+ }>, import("@scalar/typebox").TObject<{
25
+ 'x-scalar-ignore': import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
26
+ }>, import("@scalar/typebox").TObject<{
27
+ 'x-scalar-order': import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TString>>;
28
+ }>]>;
29
+ /** Adds metadata to a single tag that is used by the Operation Object. It is not mandatory to have a Tag Object per tag defined in the Operation Object instances. */
30
+ export type TagObject = {
31
+ /** REQUIRED. The name of the tag. */
32
+ name: string;
33
+ /** A short summary of the tag, used for display purposes. Added in OpenAPI 3.2. */
34
+ summary?: string;
35
+ /** A description for the tag. CommonMark syntax MAY be used for rich text representation. */
36
+ description?: string;
37
+ /** Additional external documentation for this tag. */
38
+ externalDocs?: ExternalDocumentationObject;
39
+ /** The name of a tag that this tag is nested under. The named tag MUST exist in the API description, and circular references between parent and child tags MUST NOT be used. Added in OpenAPI 3.2. */
40
+ parent?: string;
41
+ /** A machine-readable string to categorize what sort of tag it is. Any string value can be used; common uses are nav for Navigation, badge for visible badges, audience for APIs used by different groups. Added in OpenAPI 3.2. */
42
+ kind?: string;
43
+ } & XDisplayName & XInternal & XScalarIgnore & XScalarOrder;
44
+ //# sourceMappingURL=tag.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"tag.d.ts","sourceRoot":"","sources":["../../../../src/schemas/v3.2/strict/tag.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,KAAK,SAAS,EAAmB,MAAM,0CAA0C,CAAA;AAC1F,OAAO,EAAE,KAAK,aAAa,EAAuB,MAAM,+CAA+C,CAAA;AACvG,OAAO,EAAE,KAAK,YAAY,EAAsB,MAAM,6CAA6C,CAAA;AACnG,OAAO,EAAE,KAAK,YAAY,EAAsB,MAAM,yCAAyC,CAAA;AAE/F,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,0BAA0B,CAAA;AAG3E,sKAAsK;AACtK,eAAO,MAAM,yBAAyB;IAElC,qCAAqC;;IAErC,mFAAmF;;IAEnF,6FAA6F;;IAE7F,sDAAsD;;IAEtD,sMAAsM;;IAEtM,oOAAoO;;;;;;;;;;IAOvO,CAAA;AAED,sKAAsK;AACtK,MAAM,MAAM,SAAS,GAAG;IACtB,qCAAqC;IACrC,IAAI,EAAE,MAAM,CAAA;IACZ,mFAAmF;IACnF,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,6FAA6F;IAC7F,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,sDAAsD;IACtD,YAAY,CAAC,EAAE,2BAA2B,CAAA;IAC1C,sMAAsM;IACtM,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,oOAAoO;IACpO,IAAI,CAAC,EAAE,MAAM,CAAA;CACd,GAAG,YAAY,GACd,SAAS,GACT,aAAa,GACb,YAAY,CAAA"}
@@ -0,0 +1,22 @@
1
+ import { Type } from '@scalar/typebox';
2
+ import { compose } from '../../../schemas/compose.js';
3
+ import { XInternalSchema } from '../../../schemas/extensions/document/x-internal.js';
4
+ import { XScalarIgnoreSchema } from '../../../schemas/extensions/document/x-scalar-ignore.js';
5
+ import { XScalarOrderSchema } from '../../../schemas/extensions/general/x-scalar-order.js';
6
+ import { XDisplayNameSchema } from '../../../schemas/extensions/tag/x-display-name.js';
7
+ import { ExternalDocumentationObjectRef } from './ref-definitions.js';
8
+ /** Adds metadata to a single tag that is used by the Operation Object. It is not mandatory to have a Tag Object per tag defined in the Operation Object instances. */
9
+ export const TagObjectSchemaDefinition = compose(Type.Object({
10
+ /** REQUIRED. The name of the tag. */
11
+ name: Type.String(),
12
+ /** A short summary of the tag, used for display purposes. Added in OpenAPI 3.2. */
13
+ summary: Type.Optional(Type.String()),
14
+ /** A description for the tag. CommonMark syntax MAY be used for rich text representation. */
15
+ description: Type.Optional(Type.String()),
16
+ /** Additional external documentation for this tag. */
17
+ externalDocs: Type.Optional(ExternalDocumentationObjectRef),
18
+ /** The name of a tag that this tag is nested under. The named tag MUST exist in the API description, and circular references between parent and child tags MUST NOT be used. Added in OpenAPI 3.2. */
19
+ parent: Type.Optional(Type.String()),
20
+ /** A machine-readable string to categorize what sort of tag it is. Any string value can be used; common uses are nav for Navigation, badge for visible badges, audience for APIs used by different groups. Added in OpenAPI 3.2. */
21
+ kind: Type.Optional(Type.String()),
22
+ }), XDisplayNameSchema, XInternalSchema, XScalarIgnoreSchema, XScalarOrderSchema);
@@ -0,0 +1,24 @@
1
+ import type { SchemaObject } from '../../../schemas/v3.2/strict/openapi-document.js';
2
+ import type { ParameterObject, ParameterWithContentObject } from '../../../schemas/v3.2/strict/parameter.js';
3
+ export declare const isObjectSchema: (schema: SchemaObject) => schema is Extract<SchemaObject, {
4
+ type: "object";
5
+ }>;
6
+ export declare const isArraySchema: (schema: SchemaObject) => schema is Extract<SchemaObject, {
7
+ type: "array";
8
+ }>;
9
+ export declare const isStringSchema: (schema: SchemaObject) => schema is Extract<SchemaObject, {
10
+ type: "string";
11
+ }>;
12
+ export declare const isNumberSchema: (schema: SchemaObject) => schema is Extract<SchemaObject, {
13
+ type: "number" | "integer";
14
+ }>;
15
+ /** Special type guard to remove our internal type */
16
+ export declare const isSchema: (schema: SchemaObject | undefined) => schema is Exclude<SchemaObject, {
17
+ __scalar_: string;
18
+ }>;
19
+ /**
20
+ * Type guard to check if the given parameter is a ParameterWithContentObject,
21
+ * i.e., it has a 'content' property defined.
22
+ */
23
+ export declare const isContentTypeParameterObject: (parameter: ParameterObject) => parameter is ParameterWithContentObject;
24
+ //# sourceMappingURL=type-guards.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"type-guards.d.ts","sourceRoot":"","sources":["../../../../src/schemas/v3.2/strict/type-guards.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,wCAAwC,CAAA;AAC1E,OAAO,KAAK,EAAE,eAAe,EAAE,0BAA0B,EAAE,MAAM,iCAAiC,CAAA;AAElG,eAAO,MAAM,cAAc,GAAI,QAAQ,YAAY,KAAG,MAAM,IAAI,OAAO,CAAC,YAAY,EAAE;IAAE,IAAI,EAAE,QAAQ,CAAA;CAAE,CAIvG,CAAA;AAED,eAAO,MAAM,aAAa,GAAI,QAAQ,YAAY,KAAG,MAAM,IAAI,OAAO,CAAC,YAAY,EAAE;IAAE,IAAI,EAAE,OAAO,CAAA;CAAE,CAErG,CAAA;AAED,eAAO,MAAM,cAAc,GAAI,QAAQ,YAAY,KAAG,MAAM,IAAI,OAAO,CAAC,YAAY,EAAE;IAAE,IAAI,EAAE,QAAQ,CAAA;CAAE,CAIvG,CAAA;AAED,eAAO,MAAM,cAAc,GACzB,QAAQ,YAAY,KACnB,MAAM,IAAI,OAAO,CAAC,YAAY,EAAE;IAAE,IAAI,EAAE,QAAQ,GAAG,SAAS,CAAA;CAAE,CAQhE,CAAA;AAED,qDAAqD;AACrD,eAAO,MAAM,QAAQ,GAAI,QAAQ,YAAY,GAAG,SAAS,KAAG,MAAM,IAAI,OAAO,CAAC,YAAY,EAAE;IAAE,SAAS,EAAE,MAAM,CAAA;CAAE,CACvE,CAAA;AAE1C;;;GAGG;AACH,eAAO,MAAM,4BAA4B,GAAI,WAAW,eAAe,KAAG,SAAS,IAAI,0BAEtF,CAAA"}