@scalar/api-reference 1.22.35 → 1.22.37

package/CHANGELOG.md

@@ -1,5 +1,26 @@
 # @scalar/api-reference
 
+## 1.22.37
+
+### Patch Changes
+
+- e3a72bb: style: updated icon button size
+- Updated dependencies [e3a72bb]
+  - @scalar/components@0.7.9
+  - @scalar/api-client@1.2.26
+
+## 1.22.36
+
+### Patch Changes
+
+- 79e3caa: chore: replace petstore example with galaxy example
+- 5d0e06c: fix: api client blur, modal size, client contrast with clickout area
+- c6ee654: feat: hide operations with x-internal: true
+- Updated dependencies [79e3caa]
+- Updated dependencies [e022ee6]
+  - @scalar/api-client@1.2.25
+  - @scalar/components@0.7.8
+
 ## 1.22.35
 
 ### Patch Changes

package/README.md

@@ -30,6 +30,73 @@ import { ApiReference } from '@scalar/api-reference'
 
 You can even [mount the component in React](https://github.com/scalar/scalar/blob/main/examples/react/src/App.tsx).
 
+## OpenAPI Specification
+
+We’re expecting the passed specification to adhere to [the Swagger 2.0, OpenAPI 3.0 or OpenAPI 3.1 specification](https://github.com/OAI/OpenAPI-Specification).
+
+On top of that, we’ve added a few things for your convenience:
+
+### x-displayName
+
+You can overwrite tag names with `x-displayName`.
+
+```diff
+openapi: 3.1.0
+info:
+  title: Example
+  version: "1.0"
+tags:
+  - name: pl4n3t5
++    x-displayName: planets
+paths:
+  '/planets':
+    get:
+      summary: Get all planets
+      tags:
+        - pl4n3t5
+```
+
+### x-tagGroup
+
+You can group your tags with `x-tagGroup`.
+
+```diff
+openapi: 3.1.0
+info:
+  title: Example
+  version: "1.0"
+tags:
+  - name: planets
++x-tagGroups:
++  - name: galaxy
++    tags:
++      - planets
+paths:
+  '/planets':
+    get:
+      summary: Get all planets
+      tags:
+        - planets
+```
+
+### x-internal
+
+You can hide operations from the reference with `x-internal`.
+
+```diff
+openapi: 3.1.0
+info:
+  title: Example
+  version: "1.0"
+paths:
+  '/planets':
+    get:
+      summary: Get all planets
+    post:
+      summary: Create a new planet
++      x-internal: true
+```
+
 ## Configuration
 
 There’s a configuration object that can be used on all platforms. In Vue.js, you use it like this:
@@ -192,8 +259,8 @@ For OpenAuth2 it’s more looking like this:
   authentication: {
       // The OpenAPI file has keys for all security schemes
       // Which one should be used by default?
-      preferredSecurityScheme: 'planets_auth',
-      // The `petstore_auth` security scheme is of type `oAuth2`, so prefill the client id and the scopes:
+      preferredSecurityScheme: 'oauth2',
+      // The `oauth2` security scheme is of type `oAuth2`, so prefill the client id and the scopes:
       oAuth2: {
         clientId: 'foobar123',
         // optional: