@scalar/api-reference 0.8.1 → 0.8.3

package/CHANGELOG.md

@@ -1,5 +1,29 @@
 # @scalar/api-reference
 
+## 0.8.3
+
+### Patch Changes
+
+- d5fccba9: add ai writer to swagger editor
+- Updated dependencies [d5fccba9]
+  - @scalar/swagger-editor@0.6.26
+
+## 0.8.2
+
+### Patch Changes
+
+- 3b042270: fix: active state for operations with multiple tags
+- 4685f391: feat: introducing the new universal configuration object
+- 8ac1ad69: chore: use different heading levels
+- 28191084: feat: add security schemes to the reference
+- e01134d4: style: use horizontal ellipsis to indicate strings in example responses
+- Updated dependencies [64f8a018]
+- Updated dependencies [ce04794a]
+- Updated dependencies [7c3091c6]
+  - @scalar/use-codemirror@0.7.10
+  - @scalar/api-client@0.7.23
+  - @scalar/swagger-editor@0.6.25
+
 ## 0.8.1
 
 ### Patch Changes

package/README.md

@@ -29,38 +29,40 @@ import { ApiReference } from '@scalar/api-reference'
 
 You can even [mount the component in React](https://github.com/scalar/scalar/blob/main/projects/react/src/App.tsx).
 
-## Props
+## Configuration
+
+There’s an configuration object, which can use on all platforms. In Vue.js you’re using it like this:
 
 #### isEditable?: boolean
 
 Whether the Swagger editor should be shown.
 
 ```vue
-<ApiReference :isEditable="true" />
+<ApiReference :configuration="{ isEditable: true }" />
 ```
 
-#### spec?: string
+#### spec.content?: string
 
 Directly pass an OpenAPI/Swagger spec.
 
 ```vue
-<ApiReference :spec="{ … }" />
+<ApiReference :configuration="{ spec: { content: '{ … }' } }" />
 ```
 
-#### specUrl?: string
+#### spec.url?: string
 
 Pass the URL of a spec file (JSON or Yaml).
 
 ```vue
-<ApiReference specUrl="/swagger.json" />
+<ApiReference :configuration="{ spec: { url: '/swagger.json' } }" />
 ```
 
-#### transformedSpec?: string
+#### spec.preparsedContent?: string
 
 You can preprocess specs with `@scalar/swagger-parser` and directly pass the result.
 
 ```vue
-<ApiReference :specResult="{ … }" />
+<ApiReference :configuration="{ spec: { preparsedContent : '{ … }' } } />
 ```
 
 #### proxyUrl?: string
@@ -68,23 +70,25 @@ You can preprocess specs with `@scalar/swagger-parser` and directly pass the res
 Making requests to other domains is restricted in the browser and requires [CORS headers](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS). It’s recommended to use a proxy to send requests to other origins.
 
 ```vue
-<ApiReference proxyUrl="https://proxy.example.com" />
+<ApiReference :configuration="{ proxy: 'https://proxy.example.com' }" />
 ```
 
 ℹ️ You can use [@scalar/api-client-proxy](https://github.com/scalar/scalar/tree/main/packages/api-client-proxy) to host your own proxy or you can just use ours:
 
 ```vue
-<ApiReference proxyUrl="https://api.scalar.com/request-proxy" />
+<ApiReference
+  :configuration="{ proxy: 'https://api.scalar.com/request-proxy' }" />
 ```
 
-#### initialTabState?: string
+#### initialContent?: string
 
 You can decide which tab should be active by default:
 
 ```vue
-<ApiReference initialTabState="Getting Started" />
+<ApiReference
+  :initialTabState="{ tabs: { initialContent: 'Getting Started' } }" />
 <!-- or -->
-<ApiReference initialTabState="Swagger Editor" />
+<ApiReference :configuration="{ tabs: { initialContent: 'Swagger Editor' } }" />
 ```
 
 #### showSidebar?: boolean
@@ -92,7 +96,7 @@ You can decide which tab should be active by default:
 Whether the sidebar should be shown.
 
 ```vue
-<ApiReference :showSidebar="true" />
+<ApiReference :configuration="{ showSidebar: true} />
 ```
 
 #### footerBelowSidebar?: boolean
@@ -100,5 +104,5 @@ Whether the sidebar should be shown.
 Whether the footer should below the content or below the content _and_ the sidebar.
 
 ```vue
-<ApiReference :footerBelowSidebar="true" />
+<ApiReference :configuration="{ footerBelowSidebar: true} />
 ```