@scalar/api-reference 0.4.0 → 0.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.
Files changed (12) hide show
  1. package/README.md +44 -0
  2. package/dist/components/ApiReference.vue.d.ts +0 -24
  3. package/dist/components/ApiReference.vue.d.ts.map +1 -1
  4. package/dist/components/Content/ReferenceEndpoint/ExampleResponses.vue.d.ts.map +1 -1
  5. package/dist/index.js +24067 -24011
  6. package/dist/types.d.ts +0 -4
  7. package/dist/types.d.ts.map +1 -1
  8. package/package.json +31 -11
  9. package/src/components/ApiReference.vue +0 -4
  10. package/src/components/Content/ReferenceEndpoint/ExampleRequest.vue +4 -3
  11. package/src/components/Content/ReferenceEndpoint/ExampleResponses.vue +2 -1
  12. package/src/types.ts +0 -4
package/README.md ADDED
@@ -0,0 +1,44 @@
1
+ # Scalar API Reference
2
+
3
+ ![Version](https://img.shields.io/npm/v/%40scalar/api-reference)
4
+ ![Downloads](https://img.shields.io/npm/dm/%40scalar/api-reference)
5
+ ![License](https://img.shields.io/npm/l/%40scalar%2Fapi-reference)
6
+ [![Discord](https://img.shields.io/discord/1135330207960678410?style=flat&color=5865F2)](https://discord.gg/mw6FQRPh)
7
+
8
+ ## Installation
9
+
10
+ ```bash
11
+ npm install @scalar/api-reference
12
+ ```
13
+
14
+ ## Usage
15
+
16
+ ```vue
17
+ <script setup>
18
+ import { ApiReference } from '@scalar/api-reference'
19
+ </script>
20
+
21
+ <template>
22
+ <ApiReference />
23
+ </template>
24
+ ```
25
+
26
+ ## Props
27
+
28
+ ### isEditable?: boolean
29
+
30
+ ```vue
31
+ <ApiReference :isEditable="true" />
32
+ ```
33
+
34
+ ### spec?: string
35
+
36
+ ```vue
37
+ <ApiReference spec="{ … }" />
38
+ ```
39
+
40
+ ### specUrl?: string
41
+
42
+ ```vue
43
+ <ApiReference specUrl="/swagger.json" />
44
+ ```
package/dist/components/ApiReference.vue.d.ts CHANGED
@@ -4,18 +4,6 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
4
4
  spec: {
5
5
  type: import("vue").PropType<string>;
6
6
  };
7
- documentName: {
8
- type: import("vue").PropType<string>;
9
- };
10
- token: {
11
- type: import("vue").PropType<string>;
12
- };
13
- username: {
14
- type: import("vue").PropType<string>;
15
- };
16
- hocusPocusUrl: {
17
- type: import("vue").PropType<string>;
18
- };
19
7
  isEditable: {
20
8
  type: import("vue").PropType<boolean>;
21
9
  default: boolean;
@@ -34,18 +22,6 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
34
22
  spec: {
35
23
  type: import("vue").PropType<string>;
36
24
  };
37
- documentName: {
38
- type: import("vue").PropType<string>;
39
- };
40
- token: {
41
- type: import("vue").PropType<string>;
42
- };
43
- username: {
44
- type: import("vue").PropType<string>;
45
- };
46
- hocusPocusUrl: {
47
- type: import("vue").PropType<string>;
48
- };
49
25
  isEditable: {
50
26
  type: import("vue").PropType<boolean>;
51
27
  default: boolean;
package/dist/components/ApiReference.vue.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"ApiReference.vue.d.ts","sourceRoot":"","sources":["../../src/components/ApiReference.vue.ts"],"names":[],"mappings":"AAGA,OAAO,qCAAqC,CAAA;AAC5C,OAAO,iCAAiC,CAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAkYxC,wBAA8G;AAU9G,KAAK,uBAAuB,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG;IAAE,QAAO;QAClD,MAAM,EAAE,CAAC,CAAC;KACT,CAAA;CAAE,CAAC"}
1
+ {"version":3,"file":"ApiReference.vue.d.ts","sourceRoot":"","sources":["../../src/components/ApiReference.vue.ts"],"names":[],"mappings":"AAGA,OAAO,qCAAqC,CAAA;AAC5C,OAAO,iCAAiC,CAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAkYxC,wBAA8G;AAU9G,KAAK,uBAAuB,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG;IAAE,QAAO;QAClD,MAAM,EAAE,CAAC,CAAC;KACT,CAAA;CAAE,CAAC"}
package/dist/components/Content/ReferenceEndpoint/ExampleResponses.vue.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"ExampleResponses.vue.d.ts","sourceRoot":"","sources":["../../../../src/components/Content/ReferenceEndpoint/ExampleResponses.vue.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,gBAAgB,CAAA;;;;;;;;;;;;AA8W1D,wBAAkD"}
1
+ {"version":3,"file":"ExampleResponses.vue.d.ts","sourceRoot":"","sources":["../../../../src/components/Content/ReferenceEndpoint/ExampleResponses.vue.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,gBAAgB,CAAA;;;;;;;;;;;;AA8W1D,wBAAkD"}