@scalar/api-reference 1.4.0 → 1.6.1

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 (61) hide show
  1. package/CHANGELOG.md +41 -0
  2. package/README.md +12 -18
  3. package/dist/browser/standalone.js +7 -7
  4. package/dist/components/Anchor/Anchor.vue.d.ts.map +1 -1
  5. package/dist/components/ApiClientModal.vue.d.ts +2 -0
  6. package/dist/components/ApiClientModal.vue.d.ts.map +1 -1
  7. package/dist/components/ApiReference.vue.d.ts +5 -1
  8. package/dist/components/ApiReference.vue.d.ts.map +1 -1
  9. package/dist/components/ApiReferenceBase.vue.d.ts +0 -2
  10. package/dist/components/ApiReferenceBase.vue.d.ts.map +1 -1
  11. package/dist/components/ApiReferenceLayout.vue.d.ts +304 -82
  12. package/dist/components/ApiReferenceLayout.vue.d.ts.map +1 -1
  13. package/dist/components/Badge/Badge.stories.d.ts +8 -0
  14. package/dist/components/Badge/Badge.stories.d.ts.map +1 -0
  15. package/dist/components/Badge/Badge.vue.d.ts +10 -0
  16. package/dist/components/Badge/Badge.vue.d.ts.map +1 -0
  17. package/dist/components/Badge/index.d.ts +2 -0
  18. package/dist/components/Badge/index.d.ts.map +1 -0
  19. package/dist/components/Content/Introduction/DownloadSpec.vue.d.ts.map +1 -1
  20. package/dist/components/Content/Introduction/Introduction.vue.d.ts.map +1 -1
  21. package/dist/components/Content/ReferenceEndpoint/ExampleRequest.vue.d.ts.map +1 -1
  22. package/dist/components/Content/ReferenceEndpoint/ReferenceEndpoint.vue.d.ts.map +1 -1
  23. package/dist/components/Content/Schema.stories.d.ts.map +1 -1
  24. package/dist/components/Content/SchemaProperty.vue.d.ts.map +1 -1
  25. package/dist/components/DarkModeIconToggle.vue.d.ts.map +1 -1
  26. package/dist/components/FlowButton.vue.d.ts.map +1 -1
  27. package/dist/components/GettingStarted.vue.d.ts +27 -0
  28. package/dist/components/GettingStarted.vue.d.ts.map +1 -0
  29. package/dist/components/Layouts/BaseLayout.vue.d.ts +18 -0
  30. package/dist/components/Layouts/BaseLayout.vue.d.ts.map +1 -0
  31. package/dist/components/Layouts/index.d.ts +4 -3
  32. package/dist/components/Layouts/index.d.ts.map +1 -1
  33. package/dist/components/ScreenReader.vue.d.ts +37 -0
  34. package/dist/components/ScreenReader.vue.d.ts.map +1 -0
  35. package/dist/components/Sidebar.vue.d.ts.map +1 -1
  36. package/dist/components/SidebarElement.vue.d.ts +2 -0
  37. package/dist/components/SidebarElement.vue.d.ts.map +1 -1
  38. package/dist/helpers/getApiClientRequest.d.ts.map +1 -1
  39. package/dist/helpers/getExampleFromSchema.d.ts.map +1 -1
  40. package/dist/helpers/getParametersFromOperation.d.ts +13 -0
  41. package/dist/helpers/getParametersFromOperation.d.ts.map +1 -0
  42. package/dist/helpers/getRequestFromOperation.d.ts.map +1 -1
  43. package/dist/helpers/index.d.ts +2 -1
  44. package/dist/helpers/index.d.ts.map +1 -1
  45. package/dist/helpers/openClientFor.d.ts +3 -0
  46. package/dist/helpers/openClientFor.d.ts.map +1 -0
  47. package/dist/hooks/useNavigation.d.ts +1 -0
  48. package/dist/hooks/useNavigation.d.ts.map +1 -1
  49. package/dist/hooks/useParser.d.ts +24 -9
  50. package/dist/hooks/useParser.d.ts.map +1 -1
  51. package/dist/index-37e942b6.js +882 -0
  52. package/dist/{index-0f5b8a92.js → index-b54301df.js} +20326 -20295
  53. package/dist/index.d.ts +1 -0
  54. package/dist/index.d.ts.map +1 -1
  55. package/dist/index.js +20 -14
  56. package/dist/types.d.ts +19 -17
  57. package/dist/types.d.ts.map +1 -1
  58. package/package.json +5 -5
  59. package/dist/helpers/showItemInClient.d.ts +0 -3
  60. package/dist/helpers/showItemInClient.d.ts.map +0 -1
  61. package/dist/index-1eca3167.js +0 -1006
package/CHANGELOG.md CHANGED
@@ -1,5 +1,46 @@
1
1
  # @scalar/api-reference
2
2
 
3
+ ## 1.6.1
4
+
5
+ ### Patch Changes
6
+
7
+ - f87910d: feat: prefill path, header, cookie, query parameters from the spec
8
+ - Updated dependencies [f87910d]
9
+ - @scalar/api-client@0.8.1
10
+
11
+ ## 1.6.0
12
+
13
+ ### Minor Changes
14
+
15
+ - c04c2ea: feat: show references sidebar slot content in api client sidebar
16
+
17
+ ### Patch Changes
18
+
19
+ - 90ffeb5: refactor: extract layout type into component
20
+ - 98e01a2: fix: prevent css leakage from references reset
21
+ - 654333a: fix: oneOf rules for arrays are ignored
22
+ - 84c0c77: chore: change Download OpenAPI Spec button text
23
+ - 4e5d00e: style: visualize deprecated operations
24
+ - Updated dependencies [98e01a2]
25
+ - Updated dependencies [c04c2ea]
26
+ - @scalar/swagger-editor@0.8.1
27
+
28
+ ## 1.5.0
29
+
30
+ ### Minor Changes
31
+
32
+ - f38bb61: chore: remove swagger editor tabs
33
+
34
+ ### Patch Changes
35
+
36
+ - 349589a: feat: expose spec content updates
37
+ - Updated dependencies [349589a]
38
+ - Updated dependencies [f38bb61]
39
+ - @scalar/api-client@0.8.0
40
+ - @scalar/swagger-editor@0.8.0
41
+ - @scalar/use-modal@0.2.0
42
+ - @scalar/themes@0.5.0
43
+
3
44
  ## 1.4.0
4
45
 
5
46
  ### Minor Changes
package/README.md CHANGED
@@ -81,24 +81,6 @@ Making requests to other domains is restricted in the browser and requires [CORS
81
81
  :configuration="{ proxy: 'https://api.scalar.com/request-proxy' }" />
82
82
  ```
83
83
 
84
- #### initialContent?: string
85
-
86
- You can decide which tab should be active by default:
87
-
88
- ```vue
89
- <ApiReference
90
- :initialTabState="{ tabs: { initialContent: 'Getting Started' } }" />
91
- ```
92
-
93
- And you can define which tabs should be visible:
94
-
95
- ```vue
96
- <ApiReference
97
- :configuration="{
98
- tabs: { available: ['Getting Started', 'Swagger Editor'] },
99
- }" />
100
- ```
101
-
102
84
  #### showSidebar?: boolean
103
85
 
104
86
  Whether the sidebar should be shown.
@@ -148,3 +130,15 @@ You can pass information to the config object to configure meta information out
148
130
  }
149
131
  } />
150
132
  ```
133
+
134
+ #### onSpecUpdate?: (spec: string) => void
135
+
136
+ You can listen to spec changes with onSpecUpdate that runs on spec/swagger content change
137
+
138
+ ```vue
139
+ <ApiReference :configuration="{
140
+ onSpecUpdate: (value: string) => {
141
+ console.log('Content updated:', value)
142
+ }
143
+ } />
144
+ ```