@scalar/api-reference 1.19.7 → 1.20.1
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 +24 -0
- package/LICENSE +1 -1
- package/dist/browser/standalone.js +6 -6
- package/dist/browser/webpack-stats.json +1 -1
- package/dist/components/Content/Lazy/Loading.vue.d.ts.map +1 -1
- package/dist/components/Content/Operation/CustomRequestExamples.vue.d.ts +1 -1
- package/dist/components/Content/Operation/CustomRequestExamples.vue.d.ts.map +1 -1
- package/dist/components/Content/Operation/EndpointDetails.vue.d.ts +1 -1
- package/dist/components/Content/Operation/EndpointDetails.vue.d.ts.map +1 -1
- package/dist/components/Content/Operation/EndpointDetailsCard.vue.d.ts +1 -1
- package/dist/components/Content/Operation/EndpointDetailsCard.vue.d.ts.map +1 -1
- package/dist/components/Content/Operation/ExampleRequest.vue.d.ts +1 -1
- package/dist/components/Content/Operation/ExampleRequest.vue.d.ts.map +1 -1
- package/dist/components/Content/Operation/Operation.vue.d.ts +1 -1
- package/dist/components/Content/Operation/Operation.vue.d.ts.map +1 -1
- package/dist/components/Content/Operation/OperationAccordion.vue.d.ts +1 -1
- package/dist/components/Content/Operation/OperationAccordion.vue.d.ts.map +1 -1
- package/dist/components/Content/Operation/ParameterItem.vue.d.ts +1 -1
- package/dist/components/Content/Operation/ParameterItem.vue.d.ts.map +1 -1
- package/dist/components/Content/Operation/Parameters.vue.d.ts +1 -1
- package/dist/components/Content/Operation/Parameters.vue.d.ts.map +1 -1
- package/dist/components/Content/Operation/PathResponses/ExampleResponse.vue.d.ts.map +1 -1
- package/dist/components/Content/Operation/PathResponses/PathResponses.vue.d.ts +1 -1
- package/dist/components/Content/Operation/PathResponses/PathResponses.vue.d.ts.map +1 -1
- package/dist/components/Content/Operation/RequestBody.vue.d.ts +1 -1
- package/dist/components/Content/Operation/RequestBody.vue.d.ts.map +1 -1
- package/dist/components/Content/Operation/TryRequestButton.vue.d.ts +1 -1
- package/dist/components/Content/Operation/TryRequestButton.vue.d.ts.map +1 -1
- package/dist/components/Content/Schema/SchemaProperty.vue.d.ts.map +1 -1
- package/dist/components/Content/Tag/Endpoints.vue.d.ts.map +1 -1
- package/dist/components/Content/Webhooks/Webhook.vue.d.ts +1 -1
- package/dist/components/Content/Webhooks/Webhook.vue.d.ts.map +1 -1
- package/dist/components/SearchModal.vue.d.ts.map +1 -1
- package/dist/helpers/generateParameters.d.ts +1 -2
- package/dist/helpers/generateParameters.d.ts.map +1 -1
- package/dist/helpers/getApiClientRequest.d.ts +2 -1
- package/dist/helpers/getApiClientRequest.d.ts.map +1 -1
- package/dist/helpers/index.d.ts +0 -7
- package/dist/helpers/index.d.ts.map +1 -1
- package/dist/helpers/openClientFor.d.ts +1 -1
- package/dist/helpers/openClientFor.d.ts.map +1 -1
- package/dist/helpers/specHelpers.d.ts +2 -1
- package/dist/helpers/specHelpers.d.ts.map +1 -1
- package/dist/hooks/useNavState.d.ts +2 -1
- package/dist/hooks/useNavState.d.ts.map +1 -1
- package/dist/hooks/useOperation.d.ts +1 -1
- package/dist/hooks/useOperation.d.ts.map +1 -1
- package/dist/hooks/useReactiveSpec.d.ts +3 -3
- package/dist/hooks/useResponses.d.ts +1 -1
- package/dist/hooks/useResponses.d.ts.map +1 -1
- package/dist/hooks/useSidebar.d.ts.map +1 -1
- package/dist/index.js +3309 -3302
- package/dist/types.d.ts +1 -91
- package/dist/types.d.ts.map +1 -1
- package/package.json +3 -4
- package/dist/helpers/getExampleFromSchema.d.ts +0 -21
- package/dist/helpers/getExampleFromSchema.d.ts.map +0 -1
- package/dist/helpers/getHarRequest.d.ts +0 -4
- package/dist/helpers/getHarRequest.d.ts.map +0 -1
- package/dist/helpers/getParametersFromOperation.d.ts +0 -12
- package/dist/helpers/getParametersFromOperation.d.ts.map +0 -1
- package/dist/helpers/getRequestBodyFromOperation.d.ts +0 -86
- package/dist/helpers/getRequestBodyFromOperation.d.ts.map +0 -1
- package/dist/helpers/getRequestFromOperation.d.ts +0 -6
- package/dist/helpers/getRequestFromOperation.d.ts.map +0 -1
- package/dist/helpers/json2xml.d.ts +0 -5
- package/dist/helpers/json2xml.d.ts.map +0 -1
- package/dist/helpers/prettyPrintJson.d.ts +0 -5
- package/dist/helpers/prettyPrintJson.d.ts.map +0 -1
package/dist/types.d.ts
CHANGED
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { type ContentType, type TransformedOperation } from '@scalar/oas-utils';
|
|
1
2
|
import { type OpenAPIV2, type OpenAPIV3, type OpenAPIV3_1 } from '@scalar/openapi-parser';
|
|
2
3
|
import { type ThemeId } from '@scalar/themes';
|
|
3
4
|
import type { MetaFlatInput } from '@unhead/schema';
|
|
@@ -53,69 +54,6 @@ export type SpecConfiguration = {
|
|
|
53
54
|
content?: string | Record<string, any> | (() => Record<string, any>);
|
|
54
55
|
};
|
|
55
56
|
export type GettingStartedExamples = 'Petstore' | 'CoinMarketCap';
|
|
56
|
-
export type Schema = {
|
|
57
|
-
type: string;
|
|
58
|
-
name?: string;
|
|
59
|
-
example?: any;
|
|
60
|
-
default?: any;
|
|
61
|
-
format?: string;
|
|
62
|
-
description?: string;
|
|
63
|
-
properties?: Record<string, Schema>;
|
|
64
|
-
};
|
|
65
|
-
export type Parameters = {
|
|
66
|
-
name: string;
|
|
67
|
-
in?: string;
|
|
68
|
-
description?: string;
|
|
69
|
-
required?: boolean;
|
|
70
|
-
deprecated?: boolean;
|
|
71
|
-
allowEmptyValue?: boolean;
|
|
72
|
-
style?: 'form' | 'simple';
|
|
73
|
-
explode?: boolean;
|
|
74
|
-
allowReserved?: boolean;
|
|
75
|
-
schema?: Schema;
|
|
76
|
-
example?: any;
|
|
77
|
-
examples?: Map<string, any>;
|
|
78
|
-
};
|
|
79
|
-
export type Response = {
|
|
80
|
-
description: string;
|
|
81
|
-
content: any;
|
|
82
|
-
};
|
|
83
|
-
export type CustomRequestExample = {
|
|
84
|
-
lang: string;
|
|
85
|
-
label: string;
|
|
86
|
-
source: string;
|
|
87
|
-
};
|
|
88
|
-
export type Information = {
|
|
89
|
-
'description'?: string;
|
|
90
|
-
'operationId'?: string | number;
|
|
91
|
-
'parameters'?: Parameters[];
|
|
92
|
-
'responses'?: Record<string, Response>;
|
|
93
|
-
'security'?: OpenAPIV3.SecurityRequirementObject[];
|
|
94
|
-
'requestBody'?: RequestBody;
|
|
95
|
-
'summary'?: string;
|
|
96
|
-
'tags'?: string[];
|
|
97
|
-
'deprecated'?: boolean;
|
|
98
|
-
/**
|
|
99
|
-
* Scalar
|
|
100
|
-
**/
|
|
101
|
-
'x-custom-examples'?: CustomRequestExample[];
|
|
102
|
-
/**
|
|
103
|
-
* Redocly, current
|
|
104
|
-
**/
|
|
105
|
-
'x-codeSamples'?: CustomRequestExample[];
|
|
106
|
-
/**
|
|
107
|
-
* Redocly, deprecated
|
|
108
|
-
**/
|
|
109
|
-
'x-code-samples'?: CustomRequestExample[];
|
|
110
|
-
};
|
|
111
|
-
export type Operation = {
|
|
112
|
-
httpVerb: string;
|
|
113
|
-
path: string;
|
|
114
|
-
operationId?: string;
|
|
115
|
-
name?: string;
|
|
116
|
-
description?: string;
|
|
117
|
-
information?: Information;
|
|
118
|
-
};
|
|
119
57
|
export type ExampleResponseHeaders = Record<string, {
|
|
120
58
|
description: string;
|
|
121
59
|
schema: {
|
|
@@ -124,9 +62,6 @@ export type ExampleResponseHeaders = Record<string, {
|
|
|
124
62
|
example?: string;
|
|
125
63
|
};
|
|
126
64
|
}>;
|
|
127
|
-
export type TransformedOperation = Operation & {
|
|
128
|
-
pathParameters?: Parameters[];
|
|
129
|
-
};
|
|
130
65
|
export type Tag = {
|
|
131
66
|
name: string;
|
|
132
67
|
description: string;
|
|
@@ -156,22 +91,9 @@ export type ContentSchema = {
|
|
|
156
91
|
properties: ContentProperties;
|
|
157
92
|
};
|
|
158
93
|
};
|
|
159
|
-
export type ContentType = 'application/json' | 'application/xml' | 'text/plain' | 'text/html' | 'application/octet-stream' | 'application/x-www-form-urlencoded' | 'multipart/form-data';
|
|
160
94
|
export type Content = {
|
|
161
95
|
[key in ContentType]: ContentSchema;
|
|
162
96
|
};
|
|
163
|
-
export type RequestBodyMimeTypes = {
|
|
164
|
-
[K in ContentType]?: {
|
|
165
|
-
schema?: any;
|
|
166
|
-
example?: any;
|
|
167
|
-
examples?: any;
|
|
168
|
-
};
|
|
169
|
-
};
|
|
170
|
-
export type RequestBody = {
|
|
171
|
-
description?: string;
|
|
172
|
-
required?: boolean;
|
|
173
|
-
content?: RequestBodyMimeTypes;
|
|
174
|
-
};
|
|
175
97
|
export type Contact = {
|
|
176
98
|
email: string;
|
|
177
99
|
};
|
|
@@ -255,18 +177,6 @@ export type ServerState = {
|
|
|
255
177
|
servers: Server[];
|
|
256
178
|
variables: Variable[];
|
|
257
179
|
};
|
|
258
|
-
export type Header = {
|
|
259
|
-
name: string;
|
|
260
|
-
value: string;
|
|
261
|
-
};
|
|
262
|
-
export type Query = {
|
|
263
|
-
name: string;
|
|
264
|
-
value: string;
|
|
265
|
-
};
|
|
266
|
-
export type Cookie = {
|
|
267
|
-
name: string;
|
|
268
|
-
value: string;
|
|
269
|
-
};
|
|
270
180
|
export type HarRequestWithPath = HarRequest & {
|
|
271
181
|
path: string;
|
|
272
182
|
};
|
package/dist/types.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,SAAS,EACd,KAAK,SAAS,EACd,KAAK,WAAW,EACjB,MAAM,wBAAwB,CAAA;AAC/B,OAAO,EAAE,KAAK,OAAO,EAAE,MAAM,gBAAgB,CAAA;AAC7C,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAA;AACnD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAA;AAClD,OAAO,EAAE,KAAK,IAAI,EAAE,MAAM,KAAK,CAAA;AAE/B,MAAM,MAAM,cAAc,GAAG;IAC3B,aAAa,CAAC,EAAE,sBAAsB,CAAA;CACvC,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG;IACjC,aAAa,EAAE,sBAAsB,CAAA;IACrC,UAAU,EAAE,IAAI,CAAA;IAChB,OAAO,EAAE,MAAM,CAAA;CAChB,CAAA;AAED,MAAM,MAAM,sBAAsB,GAAG;IACnC,+CAA+C;IAC/C,KAAK,CAAC,EAAE,OAAO,CAAA;IACf,2CAA2C;IAC3C,MAAM,CAAC,EAAE,mBAAmB,CAAA;IAC5B,yCAAyC;IACzC,IAAI,CAAC,EAAE,iBAAiB,CAAA;IACxB,gDAAgD;IAChD,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,yCAAyC;IACzC,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,kCAAkC;IAClC,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,kDAAkD;IAClD,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,oFAAoF;IACpF,YAAY,CAAC,EACT,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,CAAA;IACP;;;SAGK;IACL,QAAQ,CAAC,EAAE,aAAa,CAAA;IACxB;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,EAAE,CAAA;IACxB,yCAAyC;IACzC,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,2DAA2D;IAC3D,YAAY,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAA;IACrC,6BAA6B;IAC7B,cAAc,CAAC,EAAE,OAAO,CAAC,mBAAmB,CAAC,CAAA;CAC9C,CAAA;AAED,MAAM,MAAM,iBAAiB,GAAG;IAC9B,oCAAoC;IACpC,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,4BAA4B;IAC5B,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,CAAC,MAAM,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAA;CACrE,CAAA;AAED,MAAM,MAAM,sBAAsB,GAAG,UAAU,GAAG,eAAe,CAAA;AAEjE,MAAM,MAAM,
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,WAAW,EAAE,KAAK,oBAAoB,EAAE,MAAM,mBAAmB,CAAA;AAC/E,OAAO,EACL,KAAK,SAAS,EACd,KAAK,SAAS,EACd,KAAK,WAAW,EACjB,MAAM,wBAAwB,CAAA;AAC/B,OAAO,EAAE,KAAK,OAAO,EAAE,MAAM,gBAAgB,CAAA;AAC7C,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAA;AACnD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAA;AAClD,OAAO,EAAE,KAAK,IAAI,EAAE,MAAM,KAAK,CAAA;AAE/B,MAAM,MAAM,cAAc,GAAG;IAC3B,aAAa,CAAC,EAAE,sBAAsB,CAAA;CACvC,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG;IACjC,aAAa,EAAE,sBAAsB,CAAA;IACrC,UAAU,EAAE,IAAI,CAAA;IAChB,OAAO,EAAE,MAAM,CAAA;CAChB,CAAA;AAED,MAAM,MAAM,sBAAsB,GAAG;IACnC,+CAA+C;IAC/C,KAAK,CAAC,EAAE,OAAO,CAAA;IACf,2CAA2C;IAC3C,MAAM,CAAC,EAAE,mBAAmB,CAAA;IAC5B,yCAAyC;IACzC,IAAI,CAAC,EAAE,iBAAiB,CAAA;IACxB,gDAAgD;IAChD,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,yCAAyC;IACzC,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,kCAAkC;IAClC,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,kDAAkD;IAClD,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,oFAAoF;IACpF,YAAY,CAAC,EACT,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,CAAA;IACP;;;SAGK;IACL,QAAQ,CAAC,EAAE,aAAa,CAAA;IACxB;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,EAAE,CAAA;IACxB,yCAAyC;IACzC,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,2DAA2D;IAC3D,YAAY,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAA;IACrC,6BAA6B;IAC7B,cAAc,CAAC,EAAE,OAAO,CAAC,mBAAmB,CAAC,CAAA;CAC9C,CAAA;AAED,MAAM,MAAM,iBAAiB,GAAG;IAC9B,oCAAoC;IACpC,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,4BAA4B;IAC5B,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,CAAC,MAAM,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAA;CACrE,CAAA;AAED,MAAM,MAAM,sBAAsB,GAAG,UAAU,GAAG,eAAe,CAAA;AAEjE,MAAM,MAAM,sBAAsB,GAAG,MAAM,CACzC,MAAM,EACN;IACE,WAAW,EAAE,MAAM,CAAA;IACnB,MAAM,EAAE;QACN,IAAI,EAAE,MAAM,CAAA;QACZ,MAAM,CAAC,EAAE,MAAM,CAAA;QACf,OAAO,CAAC,EAAE,MAAM,CAAA;KACjB,CAAA;CACF,CACF,CAAA;AAED,MAAM,MAAM,GAAG,GAAG;IAChB,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,EAAE,MAAM,CAAA;IACnB,UAAU,EAAE,oBAAoB,EAAE,CAAA;CACnC,CAAA;AACD,MAAM,MAAM,SAAS,GAAG;IACtB,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,OAAO,CAAA;IACjB,WAAW,EAAE,MAAM,CAAA;IACnB,WAAW,EAAE,MAAM,CAAA;CACpB,CAAA;AAED,MAAM,MAAM,iBAAiB,GAAG;IAC9B,CAAC,GAAG,EAAE,MAAM,GAAG;QACb,IAAI,EAAE,MAAM,CAAA;QACZ,MAAM,CAAC,EAAE,MAAM,CAAA;QACf,OAAO,CAAC,EAAE,GAAG,CAAA;QACb,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAA;QACnB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;QACf,WAAW,CAAC,EAAE,MAAM,CAAA;QACpB,UAAU,CAAC,EAAE,iBAAiB,CAAA;KAC/B,CAAA;CACF,CAAA;AAED,MAAM,MAAM,aAAa,GAAG;IAC1B,MAAM,CAAC,EAAE;QACP,IAAI,EAAE,MAAM,CAAA;QACZ,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAA;QACnB,UAAU,EAAE,iBAAiB,CAAA;KAC9B,CAAA;CACF,CAAA;AAED,MAAM,MAAM,OAAO,GAAG;KACnB,GAAG,IAAI,WAAW,GAAG,aAAa;CACpC,CAAA;AAED,MAAM,MAAM,OAAO,GAAG;IACpB,KAAK,EAAE,MAAM,CAAA;CACd,CAAA;AAED,MAAM,MAAM,OAAO,GAAG;IACpB,IAAI,EAAE,MAAM,CAAA;IACZ,GAAG,EAAE,MAAM,CAAA;CACZ,CAAA;AAED,MAAM,MAAM,IAAI,GAAG;IACjB,KAAK,EAAE,MAAM,CAAA;IACb,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,YAAY,GAAG;IACzB,WAAW,EAAE,MAAM,CAAA;IACnB,GAAG,EAAE,MAAM,CAAA;CACZ,CAAA;AAED,MAAM,MAAM,eAAe,GAAG,MAAM,CAClC,MAAM,EACN;IACE,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;IACzB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,IAAI,CAAC,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAA;CAC3B,CACF,CAAA;AAED,MAAM,MAAM,MAAM,GAAG;IACnB,GAAG,EAAE,MAAM,CAAA;IACX,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,SAAS,CAAC,EAAE,eAAe,CAAA;CAC5B,CAAA;AAED,MAAM,MAAM,QAAQ,GAAG;IACrB,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,EAAE,CAAA;CACf,CAAA;AAED,MAAM,MAAM,cAAc,GACtB,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,GACrB,SAAS,CAAC,oBAAoB,GAC9B,SAAS,CAAC,oBAAoB,GAC9B,WAAW,CAAC,oBAAoB,CAAA;AAEpC,MAAM,MAAM,WAAW,GAAG,SAAS,CAAC,iBAAiB,CAAA;AAErD,MAAM,MAAM,QAAQ,GAAG,MAAM,CAC3B,MAAM,EACN,MAAM,CAAC,WAAW,CAAC,WAAW,EAAE,oBAAoB,CAAC,CACtD,CAAA;AAED,MAAM,MAAM,IAAI,GAAG;IACjB,MAAM,CAAC,EAAE,GAAG,EAAE,CAAA;IACd,MAAM,EACF,OAAO,CAAC,SAAS,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,GACnC,OAAO,CAAC,SAAS,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,GACnC,OAAO,CAAC,WAAW,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAA;IACzC,MAAM,CAAC,EAAE,SAAS,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAA;IACnC,UAAU,CAAC,EAAE,SAAS,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAA;IAC3C,SAAS,CAAC,EAAE,SAAS,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAA;IACzC,cAAc,CAAC,EAAE,YAAY,CAAA;IAC7B,SAAS,CAAC,EAAE,MAAM,EAAE,CAAA;IACpB,YAAY,CAAC,EAAE,SAAS,CAAC,gBAAgB,GAAG,WAAW,CAAC,gBAAgB,CAAA;IACxE,UAAU,CAAC,EAAE,QAAQ,CAAA;IACrB,aAAa,CAAC,EAAE,WAAW,CAAA;IAC3B,SAAS,CAAC,EAAE,SAAS,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAA;IACzC,SAAS,CAAC,EAAE,SAAS,CAAC,QAAQ,CAAC,SAAS,CAAC,GAAG,WAAW,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAA;IAC3E,aAAa,CAAC,EAAE,QAAQ,EAAE,CAAA;IAC1B,UAAU,CAAC,EAAE,SAAS,CAAC,yBAAyB,EAAE,CAAA;CACnD,CAAA;AAED,MAAM,MAAM,mBAAmB,GAAG;IAChC,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAA;IAChC,eAAe,CAAC,EACZ,SAAS,CAAC,gBAAgB,CAAC,iBAAiB,CAAC,GAC7C,WAAW,CAAC,gBAAgB,CAAC,iBAAiB,CAAC,CAAA;IACnD,IAAI,EAAE;QACJ,KAAK,EAAE;YACL,QAAQ,EAAE,MAAM,CAAA;YAChB,QAAQ,EAAE,MAAM,CAAA;SACjB,CAAA;QACD,MAAM,EAAE;YACN,KAAK,EAAE,MAAM,CAAA;SACd,CAAA;KACF,CAAA;IACD,MAAM,EAAE;QACN,KAAK,EAAE,MAAM,CAAA;KACd,CAAA;IACD,MAAM,EAAE;QACN,QAAQ,EAAE,MAAM,CAAA;QAChB,MAAM,EAAE,MAAM,EAAE,CAAA;QAChB,WAAW,EAAE,MAAM,CAAA;QACnB,KAAK,EAAE,MAAM,CAAA;KACd,CAAA;CACF,CAAA;AAED,MAAM,MAAM,QAAQ,GAAG;IACrB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;CACtB,CAAA;AAED,MAAM,MAAM,WAAW,GAAG;IACxB,cAAc,EAAE,IAAI,GAAG,MAAM,CAAA;IAC7B,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,OAAO,EAAE,MAAM,EAAE,CAAA;IACjB,SAAS,EAAE,QAAQ,EAAE,CAAA;CACtB,CAAA;AAED,MAAM,MAAM,kBAAkB,GAAG,UAAU,GAAG;IAC5C,IAAI,EAAE,MAAM,CAAA;CACb,CAAA;AAED,MAAM,MAAM,mBAAmB,GAAG,QAAQ,GAAG,SAAS,CAAA;AAEtD,yDAAyD;AACzD,MAAM,MAAM,aAAa,GAAG,QAAQ,CAAA;AAEpC,MAAM,MAAM,cAAc,GAAG;KAE1B,CAAC,IAAI,aAAa,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;CAClD,CAAA;AAED,2DAA2D;AAC3D,MAAM,MAAM,mBAAmB,GAC3B,QAAQ,GACR,QAAQ,GACR,QAAQ,GACR,eAAe,GACf,aAAa,GACb,eAAe,GACf,aAAa,CAAA;AAEjB,MAAM,MAAM,kBAAkB,GAAG;IAC/B,IAAI,EAAE,IAAI,CAAA;IACV,UAAU,EAAE,MAAM,CAAA;CACnB,CAAA"}
|
package/package.json
CHANGED
|
@@ -15,7 +15,7 @@
|
|
|
15
15
|
"vue",
|
|
16
16
|
"vue3"
|
|
17
17
|
],
|
|
18
|
-
"version": "1.
|
|
18
|
+
"version": "1.20.1",
|
|
19
19
|
"engines": {
|
|
20
20
|
"node": ">=18"
|
|
21
21
|
},
|
|
@@ -64,10 +64,9 @@
|
|
|
64
64
|
"unhead": "^1.8.3",
|
|
65
65
|
"unified": "^11.0.4",
|
|
66
66
|
"vue-sonner": "^1.0.3",
|
|
67
|
-
"@scalar/api-client": "1.0.3",
|
|
68
67
|
"@scalar/components": "0.4.4",
|
|
69
|
-
"@scalar/oas-utils": "0.1.
|
|
70
|
-
"@scalar/
|
|
68
|
+
"@scalar/oas-utils": "0.1.1",
|
|
69
|
+
"@scalar/api-client": "1.1.0",
|
|
71
70
|
"@scalar/themes": "0.6.4",
|
|
72
71
|
"@scalar/use-modal": "0.2.9",
|
|
73
72
|
"@scalar/use-tooltip": "0.5.12"
|
|
@@ -1,21 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* This function takes a properties object and generates an example response content.
|
|
3
|
-
*/
|
|
4
|
-
export declare const getExampleFromSchema: (schema: Record<string, any>, options?: {
|
|
5
|
-
/**
|
|
6
|
-
* The fallback string for empty string values.
|
|
7
|
-
* @default ''
|
|
8
|
-
**/
|
|
9
|
-
emptyString?: string;
|
|
10
|
-
/**
|
|
11
|
-
* Whether to use the XML tag names as keys
|
|
12
|
-
* @default false
|
|
13
|
-
*/
|
|
14
|
-
xml?: boolean;
|
|
15
|
-
/**
|
|
16
|
-
* Whether to show read-only/write-only properties. Otherwise all properties are shown.
|
|
17
|
-
* @default undefined
|
|
18
|
-
*/
|
|
19
|
-
mode?: 'read' | 'write';
|
|
20
|
-
}, level?: number) => any;
|
|
21
|
-
//# sourceMappingURL=getExampleFromSchema.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"getExampleFromSchema.d.ts","sourceRoot":"","sources":["../../src/helpers/getExampleFromSchema.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,eAAO,MAAM,oBAAoB,WACvB,OAAO,MAAM,EAAE,GAAG,CAAC,YACjB;IACR;;;QAGI;IACJ,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;;;OAGG;IACH,GAAG,CAAC,EAAE,OAAO,CAAA;IACb;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAA;CACxB,UACM,MAAM,KACZ,GAwMF,CAAA"}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"getHarRequest.d.ts","sourceRoot":"","sources":["../../src/helpers/getHarRequest.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAA;AAGlD,OAAO,KAAK,EAAU,kBAAkB,EAAiB,MAAM,UAAU,CAAA;AAEzE,eAAO,MAAM,aAAa,gBACX,QAAQ,kBAAkB,CAAC,EAAE,KACzC,UAiDF,CAAA"}
|
|
@@ -1,12 +0,0 @@
|
|
|
1
|
-
import type { BaseParameter } from '@scalar/api-client';
|
|
2
|
-
import type { TransformedOperation } from '../types';
|
|
3
|
-
/**
|
|
4
|
-
* Get the query parameters from an operation.
|
|
5
|
-
*
|
|
6
|
-
* Example: [ { name: 'foobar', value: '' } ]
|
|
7
|
-
*
|
|
8
|
-
* - OpenAPI 3.x: Possible values are “query”, “header”, “path” or “cookie”.
|
|
9
|
-
* - Swagger 2.0: Possible values are "query", "header", "path", "formData" or "body".
|
|
10
|
-
*/
|
|
11
|
-
export declare function getParametersFromOperation(operation: TransformedOperation, where: 'query' | 'header' | 'path' | 'cookie' | 'formData' | 'body', requiredOnly?: boolean): BaseParameter[];
|
|
12
|
-
//# sourceMappingURL=getParametersFromOperation.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"getParametersFromOperation.d.ts","sourceRoot":"","sources":["../../src/helpers/getParametersFromOperation.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAA;AAEvD,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,UAAU,CAAA;AAGpD;;;;;;;GAOG;AACH,wBAAgB,0BAA0B,CACxC,SAAS,EAAE,oBAAoB,EAC/B,KAAK,EAAE,OAAO,GAAG,QAAQ,GAAG,MAAM,GAAG,QAAQ,GAAG,UAAU,GAAG,MAAM,EACnE,YAAY,GAAE,OAAc,GAC3B,aAAa,EAAE,CAkCjB"}
|
|
@@ -1,86 +0,0 @@
|
|
|
1
|
-
import type { ContentType, TransformedOperation } from '../types';
|
|
2
|
-
/**
|
|
3
|
-
* Get the request body from the operation.
|
|
4
|
-
*/
|
|
5
|
-
export declare function getRequestBodyFromOperation(operation: TransformedOperation, selectedExampleKey?: string | number): {
|
|
6
|
-
postData: {
|
|
7
|
-
mimeType: string;
|
|
8
|
-
text: any;
|
|
9
|
-
params?: undefined;
|
|
10
|
-
};
|
|
11
|
-
headers?: undefined;
|
|
12
|
-
} | {
|
|
13
|
-
postData: {
|
|
14
|
-
mimeType: string;
|
|
15
|
-
params: {
|
|
16
|
-
name: string;
|
|
17
|
-
value: string | number | Record<string, any>;
|
|
18
|
-
}[];
|
|
19
|
-
text?: undefined;
|
|
20
|
-
};
|
|
21
|
-
headers?: undefined;
|
|
22
|
-
} | {
|
|
23
|
-
postData: undefined;
|
|
24
|
-
headers?: undefined;
|
|
25
|
-
} | {
|
|
26
|
-
headers: {
|
|
27
|
-
name: string;
|
|
28
|
-
value: ContentType;
|
|
29
|
-
}[];
|
|
30
|
-
postData: {
|
|
31
|
-
mimeType: "application/json";
|
|
32
|
-
text: any;
|
|
33
|
-
params?: undefined;
|
|
34
|
-
};
|
|
35
|
-
} | {
|
|
36
|
-
headers: {
|
|
37
|
-
name: string;
|
|
38
|
-
value: ContentType;
|
|
39
|
-
}[];
|
|
40
|
-
postData: {
|
|
41
|
-
mimeType: "application/xml";
|
|
42
|
-
text: any;
|
|
43
|
-
params?: undefined;
|
|
44
|
-
};
|
|
45
|
-
} | {
|
|
46
|
-
headers: {
|
|
47
|
-
name: string;
|
|
48
|
-
value: ContentType;
|
|
49
|
-
}[];
|
|
50
|
-
postData: {
|
|
51
|
-
mimeType: "application/octet-stream";
|
|
52
|
-
text: string;
|
|
53
|
-
params?: undefined;
|
|
54
|
-
};
|
|
55
|
-
} | {
|
|
56
|
-
headers: {
|
|
57
|
-
name: string;
|
|
58
|
-
value: ContentType;
|
|
59
|
-
}[];
|
|
60
|
-
postData: {
|
|
61
|
-
mimeType: "text/plain";
|
|
62
|
-
text: any;
|
|
63
|
-
params?: undefined;
|
|
64
|
-
};
|
|
65
|
-
} | {
|
|
66
|
-
headers: {
|
|
67
|
-
name: string;
|
|
68
|
-
value: ContentType;
|
|
69
|
-
}[];
|
|
70
|
-
postData: {
|
|
71
|
-
mimeType: "application/x-www-form-urlencoded";
|
|
72
|
-
text?: undefined;
|
|
73
|
-
params?: undefined;
|
|
74
|
-
};
|
|
75
|
-
} | {
|
|
76
|
-
headers: {
|
|
77
|
-
name: string;
|
|
78
|
-
value: ContentType;
|
|
79
|
-
}[];
|
|
80
|
-
postData: {
|
|
81
|
-
mimeType: "multipart/form-data";
|
|
82
|
-
text?: undefined;
|
|
83
|
-
params?: undefined;
|
|
84
|
-
};
|
|
85
|
-
} | undefined;
|
|
86
|
-
//# sourceMappingURL=getRequestBodyFromOperation.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"getRequestBodyFromOperation.d.ts","sourceRoot":"","sources":["../../src/helpers/getRequestBodyFromOperation.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,oBAAoB,EAAE,MAAM,UAAU,CAAA;AAQjE;;GAEG;AACH,wBAAgB,2BAA2B,CACzC,SAAS,EAAE,oBAAoB,EAC/B,kBAAkB,CAAC,EAAE,MAAM,GAAG,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;cAqNrC"}
|
|
@@ -1,6 +0,0 @@
|
|
|
1
|
-
import type { HarRequestWithPath, TransformedOperation } from '../types';
|
|
2
|
-
export declare const getRequestFromOperation: (operation: TransformedOperation, options?: {
|
|
3
|
-
replaceVariables?: boolean;
|
|
4
|
-
requiredOnly?: boolean;
|
|
5
|
-
}, selectedExampleKey?: string | number) => Partial<HarRequestWithPath>;
|
|
6
|
-
//# sourceMappingURL=getRequestFromOperation.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"getRequestFromOperation.d.ts","sourceRoot":"","sources":["../../src/helpers/getRequestFromOperation.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAEV,kBAAkB,EAGlB,oBAAoB,EACrB,MAAM,UAAU,CAAA;AAGjB,eAAO,MAAM,uBAAuB,cACvB,oBAAoB,YACrB;IACR,gBAAgB,CAAC,EAAE,OAAO,CAAA;IAC1B,YAAY,CAAC,EAAE,OAAO,CAAA;CACvB,uBACoB,MAAM,GAAG,MAAM,KACnC,QAAQ,kBAAkB,CAsC5B,CAAA"}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"json2xml.d.ts","sourceRoot":"","sources":["../../src/helpers/json2xml.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,wBAAgB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,GAAG,CAAC,EAAE,MAAM,UA+C/D"}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"prettyPrintJson.d.ts","sourceRoot":"","sources":["../../src/helpers/prettyPrintJson.ts"],"names":[],"mappings":"AAAA;;IAEI;AACJ,eAAO,MAAM,eAAe,UAAW,GAAG,QAYzC,CAAA"}
|