@scalar/nextjs-api-reference 0.5.15 → 0.7.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 CHANGED
@@ -1,5 +1,37 @@
1
1
  # @scalar/nextjs-api-reference
2
2
 
3
+ ## 0.7.0
4
+
5
+ ### Minor Changes
6
+
7
+ - 5f9a8a2: feat!: remove the spec prefix, make content and url top-level attributes
8
+
9
+ ### Patch Changes
10
+
11
+ - Updated dependencies [5f9a8a2]
12
+ - @scalar/types@0.1.0
13
+ - @scalar/core@0.1.3
14
+
15
+ ## 0.6.1
16
+
17
+ ### Patch Changes
18
+
19
+ - Updated dependencies [fc6a45e]
20
+ - @scalar/types@0.0.41
21
+ - @scalar/core@0.1.2
22
+
23
+ ## 0.6.0
24
+
25
+ ### Minor Changes
26
+
27
+ - dd38a68: feat: use html rendering lib from @scalar/core
28
+
29
+ ### Patch Changes
30
+
31
+ - Updated dependencies [4d03e0f]
32
+ - @scalar/types@0.0.40
33
+ - @scalar/core@0.1.1
34
+
3
35
  ## 0.5.15
4
36
 
5
37
  ### Patch Changes
package/README.md CHANGED
@@ -33,9 +33,7 @@ If you have a OpenAPI/Swagger file already, you can pass a URL to the plugin in
33
33
  import { ApiReference } from '@scalar/nextjs-api-reference'
34
34
 
35
35
  const config = {
36
- spec: {
37
- url: '/openapi.json',
38
- },
36
+ url: '/openapi.json',
39
37
  }
40
38
 
41
39
  export const GET = ApiReference(config)
@@ -45,9 +43,7 @@ Or, if you just have a static OpenAPI spec, you can directly pass it as well:
45
43
 
46
44
  ```ts
47
45
  const config = {
48
- spec: {
49
- content: '...',
50
- },
46
+ content: '{ "openapi": "3.1.1", … }',
51
47
  }
52
48
  ```
53
49
 
@@ -84,9 +80,7 @@ export default function References() {
84
80
  return (
85
81
  <ApiReferenceReact
86
82
  configuration={{
87
- spec: {
88
- url: 'https://cdn.jsdelivr.net/npm/@scalar/galaxy/dist/latest.json',
89
- },
83
+ url: 'https://cdn.jsdelivr.net/npm/@scalar/galaxy/dist/latest.json',
90
84
  }}
91
85
  />
92
86
  )
@@ -106,9 +100,7 @@ You can find all available CDN versions [here](https://www.jsdelivr.com/package/
106
100
  import { ApiReference } from '@scalar/nextjs-api-reference'
107
101
 
108
102
  const config = {
109
- spec: {
110
- url: '/openapi.json',
111
- },
103
+ url: '/openapi.json',
112
104
  cdn: 'https://cdn.jsdelivr.net/npm/@scalar/api-reference@latest',
113
105
  }
114
106