@scalar/api-reference 1.15.6 → 1.16.0

package/CHANGELOG.md

@@ -1,5 +1,31 @@
 # @scalar/api-reference
 
+## 1.16.0
+
+### Minor Changes
+
+- e0faebb: feat: add show more button to request variables and path params
+
+### Patch Changes
+
+- 92a8b9f: chore: update dependencies
+- 230f9fb: feat: prefill the authentication data
+- 77c62d3: fix: path isn’t prefixed (https://github.com/scalar/scalar/issues/937)
+- Updated dependencies [e0faebb]
+- Updated dependencies [92a8b9f]
+- Updated dependencies [abfb086]
+- Updated dependencies [76f4041]
+  - @scalar/api-client@0.12.0
+  - @scalar/use-keyboard-event@0.5.9
+  - @scalar/swagger-editor@0.10.5
+  - @scalar/swagger-parser@0.5.16
+  - @scalar/use-codemirror@0.8.4
+  - @scalar/use-tooltip@0.5.9
+  - @scalar/components@0.2.3
+  - @scalar/use-toasts@0.5.14
+  - @scalar/use-modal@0.2.4
+  - @scalar/themes@0.5.5
+
 ## 1.15.6
 
 ### Patch Changes

package/README.md

@@ -154,3 +154,39 @@ You can listen to spec changes with onSpecUpdate that runs on spec/swagger conte
     }
   } />
 ```
+
+#### authentication?: Partial<AuthenticationState>
+
+To make authentication easier you can prefill the credentials for your users:
+
+````vue
+<ApiReference :configuration="{
+  authentication: {
+      // The OpenAPI file has keys for all security schemes
+      // Which one should be used by default?
+      securitySchemeKey: 'api_key',
+      // Okay, the `api_key` security scheme is of type `apiKey`, so prefill the token:
+      apiKey: {
+        token: 'super-secret-token',
+      },
+    },
+  } />
+``
+
+For OpenAuth2 it’s more looking like this:
+
+```vue
+<ApiReference :configuration="{
+  authentication: {
+      // The OpenAPI file has keys for all security schemes
+      // Which one should be used by default?
+      securitySchemeKey: 'petstore_auth',
+      // Okay, the `api_key` security scheme is of type `oAuth2`, so prefill the client id and the scopes:
+      oAuth2: {
+        clientId: 'foobar123',
+        // optional:
+        scopes: ['read:pets', 'write:pets'],
+      },
+    },
+  } />
+````