@scalar/api-reference 1.4.0 → 1.5.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.
- package/CHANGELOG.md +16 -0
- package/README.md +12 -18
- package/dist/browser/standalone.js +7 -7
- package/dist/components/ApiReference.vue.d.ts +5 -1
- package/dist/components/ApiReference.vue.d.ts.map +1 -1
- package/dist/components/ApiReferenceBase.vue.d.ts +0 -2
- package/dist/components/ApiReferenceBase.vue.d.ts.map +1 -1
- package/dist/components/ApiReferenceLayout.vue.d.ts +304 -82
- package/dist/components/ApiReferenceLayout.vue.d.ts.map +1 -1
- package/dist/components/GettingStarted.vue.d.ts +27 -0
- package/dist/components/GettingStarted.vue.d.ts.map +1 -0
- package/dist/index-06c444c3.js +879 -0
- package/dist/{index-0f5b8a92.js → index-1820592b.js} +17517 -17596
- package/dist/index.js +8 -8
- package/dist/types.d.ts +4 -10
- package/dist/types.d.ts.map +1 -1
- package/package.json +7 -7
- package/dist/index-1eca3167.js +0 -1006
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,21 @@
|
|
|
1
1
|
# @scalar/api-reference
|
|
2
2
|
|
|
3
|
+
## 1.5.0
|
|
4
|
+
|
|
5
|
+
### Minor Changes
|
|
6
|
+
|
|
7
|
+
- f38bb61: chore: remove swagger editor tabs
|
|
8
|
+
|
|
9
|
+
### Patch Changes
|
|
10
|
+
|
|
11
|
+
- 349589a: feat: expose spec content updates
|
|
12
|
+
- Updated dependencies [349589a]
|
|
13
|
+
- Updated dependencies [f38bb61]
|
|
14
|
+
- @scalar/api-client@0.8.0
|
|
15
|
+
- @scalar/swagger-editor@0.8.0
|
|
16
|
+
- @scalar/use-modal@0.2.0
|
|
17
|
+
- @scalar/themes@0.5.0
|
|
18
|
+
|
|
3
19
|
## 1.4.0
|
|
4
20
|
|
|
5
21
|
### 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
|
+
```
|