@scalar/workspace-store 0.61.0 → 0.62.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.
- package/CHANGELOG.md +20 -0
- package/dist/client.d.ts.map +1 -1
- package/dist/client.js +7 -1
- package/dist/entities/auth/schema.d.ts +200 -200
- package/dist/helpers/get-resolved-ref-deep.d.ts +1 -1
- package/dist/helpers/get-resolved-ref-deep.d.ts.map +1 -1
- package/dist/request-example/builder/build-request.d.ts.map +1 -1
- package/dist/request-example/builder/build-request.js +2 -1
- package/dist/schemas/reference-config/index.d.ts +40 -40
- package/dist/schemas/reference-config/settings.d.ts +40 -40
- package/dist/schemas/v3.1/strict/callback.d.ts +1 -1
- package/dist/schemas/v3.1/strict/components.d.ts +11 -11
- package/dist/schemas/v3.1/strict/encoding.d.ts +1 -1
- package/dist/schemas/v3.1/strict/header.d.ts +2 -2
- package/dist/schemas/v3.1/strict/media-type.d.ts +2 -2
- package/dist/schemas/v3.1/strict/openapi-document.d.ts +1260 -1260
- package/dist/schemas/v3.1/strict/operation.d.ts +3 -3
- package/dist/schemas/v3.1/strict/parameter.d.ts +2 -2
- package/dist/schemas/v3.1/strict/path-item.d.ts +10 -10
- package/dist/schemas/v3.1/strict/paths.d.ts +1 -1
- package/dist/schemas/v3.1/strict/reference.d.ts +14 -2
- package/dist/schemas/v3.1/strict/reference.d.ts.map +1 -1
- package/dist/schemas/v3.1/strict/reference.js +13 -1
- package/dist/schemas/v3.1/strict/response.d.ts +2 -2
- package/dist/schemas/v3.1/strict/responses.d.ts +1 -1
- package/dist/schemas/v3.2/openapi/index.d.ts.map +1 -1
- package/dist/schemas/v3.2/openapi/index.js +3 -0
- package/dist/schemas/v3.2/strict/callback.d.ts +1 -1
- package/dist/schemas/v3.2/strict/components.d.ts +12 -12
- package/dist/schemas/v3.2/strict/encoding.d.ts +1 -1
- package/dist/schemas/v3.2/strict/header.d.ts +2 -2
- package/dist/schemas/v3.2/strict/media-type.d.ts +3 -3
- package/dist/schemas/v3.2/strict/openapi-document.d.ts +1400 -1400
- package/dist/schemas/v3.2/strict/operation.d.ts +3 -3
- package/dist/schemas/v3.2/strict/parameter.d.ts +2 -2
- package/dist/schemas/v3.2/strict/path-item.d.ts +12 -12
- package/dist/schemas/v3.2/strict/paths.d.ts +1 -1
- package/dist/schemas/v3.2/strict/reference.d.ts +14 -2
- package/dist/schemas/v3.2/strict/reference.d.ts.map +1 -1
- package/dist/schemas/v3.2/strict/reference.js +13 -1
- package/dist/schemas/v3.2/strict/response.d.ts +2 -2
- package/dist/schemas/v3.2/strict/responses.d.ts +1 -1
- package/dist/schemas/v3.2/strict/security-scheme.d.ts +2 -2
- package/dist/schemas/v3.2/strict/security-scheme.d.ts.map +1 -1
- package/dist/schemas/v3.2/strict/security-scheme.js +1 -1
- package/dist/server.d.ts +27 -0
- package/dist/server.d.ts.map +1 -1
- package/dist/server.js +18 -0
- package/package.json +9 -9
|
@@ -36,7 +36,7 @@ export declare const OperationObjectSchemaDefinition: import("@scalar/typebox").
|
|
|
36
36
|
$status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
|
|
37
37
|
$global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
38
38
|
}>]>, import("@scalar/typebox").TObject<{
|
|
39
|
-
'$ref-value': import("@scalar/typebox").TRef<"ParameterObject"
|
|
39
|
+
'$ref-value': import("@scalar/typebox").TOptional<import("@scalar/typebox").TRef<"ParameterObject">>;
|
|
40
40
|
}>]>]>>>;
|
|
41
41
|
/** The request body applicable for this operation. The requestBody is fully supported in HTTP methods where the HTTP 1.1 specification RFC7231 has explicitly defined semantics for request bodies. In other cases where the HTTP spec is vague (such as GET, HEAD and DELETE), requestBody is permitted but does not have well-defined semantics and SHOULD be avoided if possible. */
|
|
42
42
|
requestBody: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"RequestBodyObject">, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
|
|
@@ -47,7 +47,7 @@ export declare const OperationObjectSchemaDefinition: import("@scalar/typebox").
|
|
|
47
47
|
$status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
|
|
48
48
|
$global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
49
49
|
}>]>, import("@scalar/typebox").TObject<{
|
|
50
|
-
'$ref-value': import("@scalar/typebox").TRef<"RequestBodyObject"
|
|
50
|
+
'$ref-value': import("@scalar/typebox").TOptional<import("@scalar/typebox").TRef<"RequestBodyObject">>;
|
|
51
51
|
}>]>]>>;
|
|
52
52
|
/** The list of possible responses as they are returned from executing this operation. */
|
|
53
53
|
responses: import("@scalar/typebox").TOptional<import("@scalar/typebox").TRef<"ResponsesObject">>;
|
|
@@ -66,7 +66,7 @@ export declare const OperationObjectSchemaDefinition: import("@scalar/typebox").
|
|
|
66
66
|
$status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
|
|
67
67
|
$global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
68
68
|
}>]>, import("@scalar/typebox").TObject<{
|
|
69
|
-
'$ref-value': import("@scalar/typebox").TRef<"CallbackObject"
|
|
69
|
+
'$ref-value': import("@scalar/typebox").TOptional<import("@scalar/typebox").TRef<"CallbackObject">>;
|
|
70
70
|
}>]>]>>>;
|
|
71
71
|
}>, import("@scalar/typebox").TObject<{
|
|
72
72
|
'x-badges': import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TObject<{
|
|
@@ -88,7 +88,7 @@ export declare const ParameterObjectSchemaDefinition: import("@scalar/typebox").
|
|
|
88
88
|
$status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
|
|
89
89
|
$global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
90
90
|
}>]>, import("@scalar/typebox").TObject<{
|
|
91
|
-
'$ref-value': import("@scalar/typebox").TRef<"SchemaObject"
|
|
91
|
+
'$ref-value': import("@scalar/typebox").TOptional<import("@scalar/typebox").TRef<"SchemaObject">>;
|
|
92
92
|
}>]>]>>;
|
|
93
93
|
/** Example of the header's potential value; see Working With Examples. https://swagger.io/specification/#working-with-examples */
|
|
94
94
|
example: import("@scalar/typebox").TOptional<import("@scalar/typebox").TAny>;
|
|
@@ -101,7 +101,7 @@ export declare const ParameterObjectSchemaDefinition: import("@scalar/typebox").
|
|
|
101
101
|
$status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
|
|
102
102
|
$global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
103
103
|
}>]>, import("@scalar/typebox").TObject<{
|
|
104
|
-
'$ref-value': import("@scalar/typebox").TRef<"ExampleObject"
|
|
104
|
+
'$ref-value': import("@scalar/typebox").TOptional<import("@scalar/typebox").TRef<"ExampleObject">>;
|
|
105
105
|
}>]>]>>>;
|
|
106
106
|
}>]>, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
|
|
107
107
|
/** REQUIRED. The name of the parameter. Parameter names are case sensitive.
|
|
@@ -22,7 +22,7 @@ export declare const PathItemObjectSchemaDefinition: import("@scalar/typebox").T
|
|
|
22
22
|
$status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
|
|
23
23
|
$global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
24
24
|
}>]>, import("@scalar/typebox").TObject<{
|
|
25
|
-
'$ref-value': import("@scalar/typebox").TRef<"OperationObject"
|
|
25
|
+
'$ref-value': import("@scalar/typebox").TOptional<import("@scalar/typebox").TRef<"OperationObject">>;
|
|
26
26
|
}>]>]>>;
|
|
27
27
|
/** A definition of a PUT operation on this path. */
|
|
28
28
|
put: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"OperationObject">, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
|
|
@@ -33,7 +33,7 @@ export declare const PathItemObjectSchemaDefinition: import("@scalar/typebox").T
|
|
|
33
33
|
$status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
|
|
34
34
|
$global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
35
35
|
}>]>, import("@scalar/typebox").TObject<{
|
|
36
|
-
'$ref-value': import("@scalar/typebox").TRef<"OperationObject"
|
|
36
|
+
'$ref-value': import("@scalar/typebox").TOptional<import("@scalar/typebox").TRef<"OperationObject">>;
|
|
37
37
|
}>]>]>>;
|
|
38
38
|
/** A definition of a POST operation on this path. */
|
|
39
39
|
post: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"OperationObject">, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
|
|
@@ -44,7 +44,7 @@ export declare const PathItemObjectSchemaDefinition: import("@scalar/typebox").T
|
|
|
44
44
|
$status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
|
|
45
45
|
$global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
46
46
|
}>]>, import("@scalar/typebox").TObject<{
|
|
47
|
-
'$ref-value': import("@scalar/typebox").TRef<"OperationObject"
|
|
47
|
+
'$ref-value': import("@scalar/typebox").TOptional<import("@scalar/typebox").TRef<"OperationObject">>;
|
|
48
48
|
}>]>]>>;
|
|
49
49
|
/** A definition of a DELETE operation on this path. */
|
|
50
50
|
delete: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"OperationObject">, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
|
|
@@ -55,7 +55,7 @@ export declare const PathItemObjectSchemaDefinition: import("@scalar/typebox").T
|
|
|
55
55
|
$status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
|
|
56
56
|
$global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
57
57
|
}>]>, import("@scalar/typebox").TObject<{
|
|
58
|
-
'$ref-value': import("@scalar/typebox").TRef<"OperationObject"
|
|
58
|
+
'$ref-value': import("@scalar/typebox").TOptional<import("@scalar/typebox").TRef<"OperationObject">>;
|
|
59
59
|
}>]>]>>;
|
|
60
60
|
/** A definition of a PATCH operation on this path. */
|
|
61
61
|
patch: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"OperationObject">, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
|
|
@@ -66,7 +66,7 @@ export declare const PathItemObjectSchemaDefinition: import("@scalar/typebox").T
|
|
|
66
66
|
$status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
|
|
67
67
|
$global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
68
68
|
}>]>, import("@scalar/typebox").TObject<{
|
|
69
|
-
'$ref-value': import("@scalar/typebox").TRef<"OperationObject"
|
|
69
|
+
'$ref-value': import("@scalar/typebox").TOptional<import("@scalar/typebox").TRef<"OperationObject">>;
|
|
70
70
|
}>]>]>>;
|
|
71
71
|
/** A definition of a CONNECT operation on this path. */
|
|
72
72
|
connect: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"OperationObject">, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
|
|
@@ -77,7 +77,7 @@ export declare const PathItemObjectSchemaDefinition: import("@scalar/typebox").T
|
|
|
77
77
|
$status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
|
|
78
78
|
$global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
79
79
|
}>]>, import("@scalar/typebox").TObject<{
|
|
80
|
-
'$ref-value': import("@scalar/typebox").TRef<"OperationObject"
|
|
80
|
+
'$ref-value': import("@scalar/typebox").TOptional<import("@scalar/typebox").TRef<"OperationObject">>;
|
|
81
81
|
}>]>]>>;
|
|
82
82
|
/** A definition of a OPTIONS operation on this path. */
|
|
83
83
|
options: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"OperationObject">, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
|
|
@@ -88,7 +88,7 @@ export declare const PathItemObjectSchemaDefinition: import("@scalar/typebox").T
|
|
|
88
88
|
$status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
|
|
89
89
|
$global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
90
90
|
}>]>, import("@scalar/typebox").TObject<{
|
|
91
|
-
'$ref-value': import("@scalar/typebox").TRef<"OperationObject"
|
|
91
|
+
'$ref-value': import("@scalar/typebox").TOptional<import("@scalar/typebox").TRef<"OperationObject">>;
|
|
92
92
|
}>]>]>>;
|
|
93
93
|
/** A definition of a HEAD operation on this path. */
|
|
94
94
|
head: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"OperationObject">, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
|
|
@@ -99,7 +99,7 @@ export declare const PathItemObjectSchemaDefinition: import("@scalar/typebox").T
|
|
|
99
99
|
$status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
|
|
100
100
|
$global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
101
101
|
}>]>, import("@scalar/typebox").TObject<{
|
|
102
|
-
'$ref-value': import("@scalar/typebox").TRef<"OperationObject"
|
|
102
|
+
'$ref-value': import("@scalar/typebox").TOptional<import("@scalar/typebox").TRef<"OperationObject">>;
|
|
103
103
|
}>]>]>>;
|
|
104
104
|
/** A definition of a TRACE operation on this path. */
|
|
105
105
|
trace: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"OperationObject">, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
|
|
@@ -110,7 +110,7 @@ export declare const PathItemObjectSchemaDefinition: import("@scalar/typebox").T
|
|
|
110
110
|
$status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
|
|
111
111
|
$global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
112
112
|
}>]>, import("@scalar/typebox").TObject<{
|
|
113
|
-
'$ref-value': import("@scalar/typebox").TRef<"OperationObject"
|
|
113
|
+
'$ref-value': import("@scalar/typebox").TOptional<import("@scalar/typebox").TRef<"OperationObject">>;
|
|
114
114
|
}>]>]>>;
|
|
115
115
|
/** An alternative servers array to service all operations in this path. If a servers array is specified at the OpenAPI Object level, it will be overridden by this value. */
|
|
116
116
|
servers: import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TRef<"ServerObject">>>;
|
|
@@ -123,7 +123,7 @@ export declare const PathItemObjectSchemaDefinition: import("@scalar/typebox").T
|
|
|
123
123
|
$status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
|
|
124
124
|
$global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
125
125
|
}>]>, import("@scalar/typebox").TObject<{
|
|
126
|
-
'$ref-value': import("@scalar/typebox").TRef<"ParameterObject"
|
|
126
|
+
'$ref-value': import("@scalar/typebox").TOptional<import("@scalar/typebox").TRef<"ParameterObject">>;
|
|
127
127
|
}>]>]>>>;
|
|
128
128
|
}>;
|
|
129
129
|
export type PathItemObject = {
|
|
@@ -11,7 +11,7 @@ export declare const PathsObjectSchemaDefinition: import("@scalar/typebox").TRec
|
|
|
11
11
|
$status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
|
|
12
12
|
$global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
13
13
|
}>]>, import("@scalar/typebox").TObject<{
|
|
14
|
-
'$ref-value': import("@scalar/typebox").TRef<"PathItemObject"
|
|
14
|
+
'$ref-value': import("@scalar/typebox").TOptional<import("@scalar/typebox").TRef<"PathItemObject">>;
|
|
15
15
|
}>]>]>>;
|
|
16
16
|
/**
|
|
17
17
|
* Holds the relative paths to the individual endpoints and their operations. The path is appended to the URL from the Server Object in order to construct the full URL. The Paths Object MAY be empty, due to Access Control List (ACL) constraints.
|
|
@@ -42,6 +42,18 @@ export type ReferenceObject = {
|
|
|
42
42
|
/** Indicates whether this reference should be resolved globally across all documents, rather than just within the current document context. */
|
|
43
43
|
'$global'?: boolean;
|
|
44
44
|
};
|
|
45
|
+
/**
|
|
46
|
+
* Object or Reference Object with a resolved `$ref-value`.
|
|
47
|
+
*
|
|
48
|
+
* `$ref-value` is kept optional on purpose (mirroring the schema position in `schema.ts`): an
|
|
49
|
+
* unresolved reference — for example a sparse chunk `$ref` produced by the server store — is just
|
|
50
|
+
* `{ $ref }` with no resolved value yet. If it were required, such a value would match neither
|
|
51
|
+
* union branch, so coercion would fall back to the plain-object branch and silently drop the
|
|
52
|
+
* `$ref`. With it optional the `{ $ref }` matches the reference branch and is preserved unchanged.
|
|
53
|
+
*
|
|
54
|
+
* The bundler/proxy still populates `$ref-value` for resolved documents, so `getResolvedRef` keeps
|
|
55
|
+
* returning the value in practice.
|
|
56
|
+
*/
|
|
45
57
|
export declare const reference: <T extends TSchema>(schema: T) => import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
|
|
46
58
|
/** REQUIRED. The reference identifier. This MUST be in the form of a URI. */
|
|
47
59
|
$ref: import("@scalar/typebox").TString;
|
|
@@ -55,9 +67,9 @@ export declare const reference: <T extends TSchema>(schema: T) => import("@scala
|
|
|
55
67
|
/** Indicates whether this reference should be resolved globally across all documents, rather than just within the current document context. */
|
|
56
68
|
$global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
57
69
|
}>]>, import("@scalar/typebox").TObject<{
|
|
58
|
-
'$ref-value': T
|
|
70
|
+
'$ref-value': T extends import("@scalar/typebox").TOptional<infer S extends TSchema> ? import("@scalar/typebox").TOptional<S> : import("@scalar/typebox").Ensure<import("@scalar/typebox").TOptional<T>>;
|
|
59
71
|
}>]>;
|
|
60
72
|
export type ReferenceType<Value> = Value | (ReferenceObject & {
|
|
61
|
-
'$ref-value'
|
|
73
|
+
'$ref-value'?: Value;
|
|
62
74
|
});
|
|
63
75
|
//# sourceMappingURL=reference.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"reference.d.ts","sourceRoot":"","sources":["../../../../src/schemas/v3.1/strict/reference.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,OAAO,EAAQ,MAAM,iBAAiB,CAAA;AAIpD,eAAO,MAAM,+BAA+B;IAC1C,0JAA0J;;IAE1J,+IAA+I;;EAE/I,CAAA;AAEF;;;;;sDAKsD;AACtD,eAAO,MAAM,qBAAqB;IAE9B,6EAA6E;;IAE7E,sLAAsL;;IAEtL,oPAAoP;;;IAlBtP,0JAA0J;;IAE1J,+IAA+I;;IAoBhJ,CAAA;AAED;;;;;sDAKsD;AACtD,MAAM,MAAM,eAAe,GAAG;IAC5B,6EAA6E;IAC7E,MAAM,EAAE,MAAM,CAAA;IACd,sLAAsL;IACtL,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,oPAAoP;IACpP,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,0JAA0J;IAC1J,SAAS,CAAC,EAAE,SAAS,GAAG,OAAO,CAAA;IAC/B,+IAA+I;IAC/I,SAAS,CAAC,EAAE,OAAO,CAAA;CACpB,CAAA;AAED,eAAO,MAAM,SAAS,GAAI,CAAC,SAAS,OAAO,EAAE,QAAQ,CAAC;
|
|
1
|
+
{"version":3,"file":"reference.d.ts","sourceRoot":"","sources":["../../../../src/schemas/v3.1/strict/reference.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,OAAO,EAAQ,MAAM,iBAAiB,CAAA;AAIpD,eAAO,MAAM,+BAA+B;IAC1C,0JAA0J;;IAE1J,+IAA+I;;EAE/I,CAAA;AAEF;;;;;sDAKsD;AACtD,eAAO,MAAM,qBAAqB;IAE9B,6EAA6E;;IAE7E,sLAAsL;;IAEtL,oPAAoP;;;IAlBtP,0JAA0J;;IAE1J,+IAA+I;;IAoBhJ,CAAA;AAED;;;;;sDAKsD;AACtD,MAAM,MAAM,eAAe,GAAG;IAC5B,6EAA6E;IAC7E,MAAM,EAAE,MAAM,CAAA;IACd,sLAAsL;IACtL,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,oPAAoP;IACpP,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,0JAA0J;IAC1J,SAAS,CAAC,EAAE,SAAS,GAAG,OAAO,CAAA;IAC/B,+IAA+I;IAC/I,SAAS,CAAC,EAAE,OAAO,CAAA;CACpB,CAAA;AAED;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,SAAS,GAAI,CAAC,SAAS,OAAO,EAAE,QAAQ,CAAC;IAzClD,6EAA6E;;IAE7E,sLAAsL;;IAEtL,oPAAoP;;;IAlBtP,0JAA0J;;IAE1J,+IAA+I;;;;IAsD3D,CAAA;AAEtF,MAAM,MAAM,aAAa,CAAC,KAAK,IAAI,KAAK,GAAG,CAAC,eAAe,GAAG;IAAE,YAAY,CAAC,EAAE,KAAK,CAAA;CAAE,CAAC,CAAA"}
|
|
@@ -20,4 +20,16 @@ export const ReferenceObjectSchema = compose(Type.Object({
|
|
|
20
20
|
/** A description which by default SHOULD override that of the referenced component. CommonMark syntax MAY be used for rich text representation. If the referenced object-type does not allow a description field, then this field has no effect. */
|
|
21
21
|
description: Type.Optional(Type.String()),
|
|
22
22
|
}), ReferenceObjectExtensionsSchema);
|
|
23
|
-
|
|
23
|
+
/**
|
|
24
|
+
* Object or Reference Object with a resolved `$ref-value`.
|
|
25
|
+
*
|
|
26
|
+
* `$ref-value` is kept optional on purpose (mirroring the schema position in `schema.ts`): an
|
|
27
|
+
* unresolved reference — for example a sparse chunk `$ref` produced by the server store — is just
|
|
28
|
+
* `{ $ref }` with no resolved value yet. If it were required, such a value would match neither
|
|
29
|
+
* union branch, so coercion would fall back to the plain-object branch and silently drop the
|
|
30
|
+
* `$ref`. With it optional the `{ $ref }` matches the reference branch and is preserved unchanged.
|
|
31
|
+
*
|
|
32
|
+
* The bundler/proxy still populates `$ref-value` for resolved documents, so `getResolvedRef` keeps
|
|
33
|
+
* returning the value in practice.
|
|
34
|
+
*/
|
|
35
|
+
export const reference = (schema) => compose(ReferenceObjectSchema, Type.Object({ '$ref-value': Type.Optional(schema) }));
|
|
@@ -14,7 +14,7 @@ export declare const ResponseObjectSchemaDefinition: import("@scalar/typebox").T
|
|
|
14
14
|
$status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
|
|
15
15
|
$global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
16
16
|
}>]>, import("@scalar/typebox").TObject<{
|
|
17
|
-
'$ref-value': import("@scalar/typebox").TRef<"HeaderObject"
|
|
17
|
+
'$ref-value': import("@scalar/typebox").TOptional<import("@scalar/typebox").TRef<"HeaderObject">>;
|
|
18
18
|
}>]>]>>>;
|
|
19
19
|
/** A map containing descriptions of potential response payloads. The key is a media type or media type range and the value describes it. For responses that match multiple keys, only the most specific key is applicable. e.g. "text/plain" overrides "text/*" */
|
|
20
20
|
content: import("@scalar/typebox").TOptional<import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TRef<"MediaTypeObject">>>;
|
|
@@ -27,7 +27,7 @@ export declare const ResponseObjectSchemaDefinition: import("@scalar/typebox").T
|
|
|
27
27
|
$status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
|
|
28
28
|
$global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
29
29
|
}>]>, import("@scalar/typebox").TObject<{
|
|
30
|
-
'$ref-value': import("@scalar/typebox").TRef<"LinkObject"
|
|
30
|
+
'$ref-value': import("@scalar/typebox").TOptional<import("@scalar/typebox").TRef<"LinkObject">>;
|
|
31
31
|
}>]>]>>>;
|
|
32
32
|
}>;
|
|
33
33
|
/**
|
|
@@ -17,7 +17,7 @@ export declare const ResponsesObjectSchemaDefinition: import("@scalar/typebox").
|
|
|
17
17
|
$status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
|
|
18
18
|
$global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
19
19
|
}>]>, import("@scalar/typebox").TObject<{
|
|
20
|
-
'$ref-value': import("@scalar/typebox").TRef<"ResponseObject"
|
|
20
|
+
'$ref-value': import("@scalar/typebox").TOptional<import("@scalar/typebox").TRef<"ResponseObject">>;
|
|
21
21
|
}>]>]>>;
|
|
22
22
|
/**
|
|
23
23
|
* A container for the expected responses of an operation. The container maps a HTTP response code to the expected response.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/schemas/v3.2/openapi/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,MAAM,EAaZ,MAAM,oBAAoB,CAAA;AA8C3B,0CAA0C;AAC1C,KAAK,qBAAqB,GAAG;IAC3B;;;;;;OAMG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAA;CAC/B,CAAA;AA8DD;;;;GAIG;AACH,eAAO,MAAM,oBAAoB,GAAI,UAAU,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,KAAG,MAyM1E,CAAA;AAED,eAAO,MAAM,cAAc,GAAI,UAAU,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,EAAE,UAAS,qBAA0B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/schemas/v3.2/openapi/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,MAAM,EAaZ,MAAM,oBAAoB,CAAA;AA8C3B,0CAA0C;AAC1C,KAAK,qBAAqB,GAAG;IAC3B;;;;;;OAMG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAA;CAC/B,CAAA;AA8DD;;;;GAIG;AACH,eAAO,MAAM,oBAAoB,GAAI,UAAU,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,KAAG,MAyM1E,CAAA;AAED,eAAO,MAAM,cAAc,GAAI,UAAU,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,EAAE,UAAS,qBAA0B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IA61BtG,CAAA"}
|
|
@@ -402,6 +402,9 @@ export const generateSchema = (maybeRef, options = {}) => {
|
|
|
402
402
|
...securitySchemeBase.properties,
|
|
403
403
|
type: literal('oauth2'),
|
|
404
404
|
flows: oauth2Flows,
|
|
405
|
+
oauth2MetadataUrl: optional(string({
|
|
406
|
+
typeComment: 'URL to the OAuth2 authorization server metadata (RFC8414). Use HTTPS, or HTTP for local development URLs.',
|
|
407
|
+
})),
|
|
405
408
|
}, { typeName: 'OAuth2SecuritySchemeObject' }),
|
|
406
409
|
XDefaultScopes,
|
|
407
410
|
]);
|
|
@@ -8,7 +8,7 @@ export declare const CallbackObjectSchemaDefinition: import("@scalar/typebox").T
|
|
|
8
8
|
$status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
|
|
9
9
|
$global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
10
10
|
}>]>, import("@scalar/typebox").TObject<{
|
|
11
|
-
'$ref-value': import("@scalar/typebox").TRef<"PathItemObject"
|
|
11
|
+
'$ref-value': import("@scalar/typebox").TOptional<import("@scalar/typebox").TRef<"PathItemObject">>;
|
|
12
12
|
}>]>]>>;
|
|
13
13
|
/** A Path Item Object used to define a callback request and expected responses. A complete example is available. */
|
|
14
14
|
export type CallbackObject = Record<string, ReferenceType<PathItemObject>>;
|
|
@@ -18,7 +18,7 @@ export declare const SecuritySchemesSchemaDefinition: import("@scalar/typebox").
|
|
|
18
18
|
$status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
|
|
19
19
|
$global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
20
20
|
}>]>, import("@scalar/typebox").TObject<{
|
|
21
|
-
'$ref-value': import("@scalar/typebox").TRef<"SecuritySchemeObject"
|
|
21
|
+
'$ref-value': import("@scalar/typebox").TOptional<import("@scalar/typebox").TRef<"SecuritySchemeObject">>;
|
|
22
22
|
}>]>]>>;
|
|
23
23
|
export type SecuritySchemes = Record<string, ReferenceType<SecuritySchemeObject>>;
|
|
24
24
|
/** Holds a set of reusable objects for different aspects of the OAS. All objects defined within the Components Object will have no effect on the API unless they are explicitly referenced from outside the Components Object. */
|
|
@@ -32,7 +32,7 @@ export declare const ComponentsObjectSchemaDefinition: import("@scalar/typebox")
|
|
|
32
32
|
$status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
|
|
33
33
|
$global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
34
34
|
}>]>, import("@scalar/typebox").TObject<{
|
|
35
|
-
'$ref-value': import("@scalar/typebox").TRef<"SchemaObject"
|
|
35
|
+
'$ref-value': import("@scalar/typebox").TOptional<import("@scalar/typebox").TRef<"SchemaObject">>;
|
|
36
36
|
}>]>]>>>;
|
|
37
37
|
/** An object to hold reusable Response Objects. */
|
|
38
38
|
responses: import("@scalar/typebox").TOptional<import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"ResponseObject">, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
|
|
@@ -43,7 +43,7 @@ export declare const ComponentsObjectSchemaDefinition: import("@scalar/typebox")
|
|
|
43
43
|
$status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
|
|
44
44
|
$global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
45
45
|
}>]>, import("@scalar/typebox").TObject<{
|
|
46
|
-
'$ref-value': import("@scalar/typebox").TRef<"ResponseObject"
|
|
46
|
+
'$ref-value': import("@scalar/typebox").TOptional<import("@scalar/typebox").TRef<"ResponseObject">>;
|
|
47
47
|
}>]>]>>>;
|
|
48
48
|
/** An object to hold reusable Parameter Objects. */
|
|
49
49
|
parameters: import("@scalar/typebox").TOptional<import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"ParameterObject">, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
|
|
@@ -54,7 +54,7 @@ export declare const ComponentsObjectSchemaDefinition: import("@scalar/typebox")
|
|
|
54
54
|
$status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
|
|
55
55
|
$global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
56
56
|
}>]>, import("@scalar/typebox").TObject<{
|
|
57
|
-
'$ref-value': import("@scalar/typebox").TRef<"ParameterObject"
|
|
57
|
+
'$ref-value': import("@scalar/typebox").TOptional<import("@scalar/typebox").TRef<"ParameterObject">>;
|
|
58
58
|
}>]>]>>>;
|
|
59
59
|
/** An object to hold reusable Example Objects. */
|
|
60
60
|
examples: import("@scalar/typebox").TOptional<import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"ExampleObject">, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
|
|
@@ -65,7 +65,7 @@ export declare const ComponentsObjectSchemaDefinition: import("@scalar/typebox")
|
|
|
65
65
|
$status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
|
|
66
66
|
$global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
67
67
|
}>]>, import("@scalar/typebox").TObject<{
|
|
68
|
-
'$ref-value': import("@scalar/typebox").TRef<"ExampleObject"
|
|
68
|
+
'$ref-value': import("@scalar/typebox").TOptional<import("@scalar/typebox").TRef<"ExampleObject">>;
|
|
69
69
|
}>]>]>>>;
|
|
70
70
|
/** An object to hold reusable Request Body Objects. */
|
|
71
71
|
requestBodies: import("@scalar/typebox").TOptional<import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"RequestBodyObject">, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
|
|
@@ -76,7 +76,7 @@ export declare const ComponentsObjectSchemaDefinition: import("@scalar/typebox")
|
|
|
76
76
|
$status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
|
|
77
77
|
$global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
78
78
|
}>]>, import("@scalar/typebox").TObject<{
|
|
79
|
-
'$ref-value': import("@scalar/typebox").TRef<"RequestBodyObject"
|
|
79
|
+
'$ref-value': import("@scalar/typebox").TOptional<import("@scalar/typebox").TRef<"RequestBodyObject">>;
|
|
80
80
|
}>]>]>>>;
|
|
81
81
|
/** An object to hold reusable Header Objects. */
|
|
82
82
|
headers: import("@scalar/typebox").TOptional<import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"HeaderObject">, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
|
|
@@ -87,7 +87,7 @@ export declare const ComponentsObjectSchemaDefinition: import("@scalar/typebox")
|
|
|
87
87
|
$status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
|
|
88
88
|
$global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
89
89
|
}>]>, import("@scalar/typebox").TObject<{
|
|
90
|
-
'$ref-value': import("@scalar/typebox").TRef<"HeaderObject"
|
|
90
|
+
'$ref-value': import("@scalar/typebox").TOptional<import("@scalar/typebox").TRef<"HeaderObject">>;
|
|
91
91
|
}>]>]>>>;
|
|
92
92
|
/** An object to hold reusable Security Scheme Objects. */
|
|
93
93
|
securitySchemes: import("@scalar/typebox").TOptional<import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"SecuritySchemeObject">, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
|
|
@@ -98,7 +98,7 @@ export declare const ComponentsObjectSchemaDefinition: import("@scalar/typebox")
|
|
|
98
98
|
$status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
|
|
99
99
|
$global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
100
100
|
}>]>, import("@scalar/typebox").TObject<{
|
|
101
|
-
'$ref-value': import("@scalar/typebox").TRef<"SecuritySchemeObject"
|
|
101
|
+
'$ref-value': import("@scalar/typebox").TOptional<import("@scalar/typebox").TRef<"SecuritySchemeObject">>;
|
|
102
102
|
}>]>]>>>;
|
|
103
103
|
/** An object to hold reusable Link Objects. */
|
|
104
104
|
links: import("@scalar/typebox").TOptional<import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"LinkObject">, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
|
|
@@ -109,7 +109,7 @@ export declare const ComponentsObjectSchemaDefinition: import("@scalar/typebox")
|
|
|
109
109
|
$status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
|
|
110
110
|
$global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
111
111
|
}>]>, import("@scalar/typebox").TObject<{
|
|
112
|
-
'$ref-value': import("@scalar/typebox").TRef<"LinkObject"
|
|
112
|
+
'$ref-value': import("@scalar/typebox").TOptional<import("@scalar/typebox").TRef<"LinkObject">>;
|
|
113
113
|
}>]>]>>>;
|
|
114
114
|
/** An object to hold reusable Callback Objects. */
|
|
115
115
|
callbacks: import("@scalar/typebox").TOptional<import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"CallbackObject">, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
|
|
@@ -120,7 +120,7 @@ export declare const ComponentsObjectSchemaDefinition: import("@scalar/typebox")
|
|
|
120
120
|
$status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
|
|
121
121
|
$global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
122
122
|
}>]>, import("@scalar/typebox").TObject<{
|
|
123
|
-
'$ref-value': import("@scalar/typebox").TRef<"CallbackObject"
|
|
123
|
+
'$ref-value': import("@scalar/typebox").TOptional<import("@scalar/typebox").TRef<"CallbackObject">>;
|
|
124
124
|
}>]>]>>>;
|
|
125
125
|
/** An object to hold reusable Path Item Objects. */
|
|
126
126
|
pathItems: import("@scalar/typebox").TOptional<import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"PathItemObject">, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
|
|
@@ -131,7 +131,7 @@ export declare const ComponentsObjectSchemaDefinition: import("@scalar/typebox")
|
|
|
131
131
|
$status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
|
|
132
132
|
$global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
133
133
|
}>]>, import("@scalar/typebox").TObject<{
|
|
134
|
-
'$ref-value': import("@scalar/typebox").TRef<"PathItemObject"
|
|
134
|
+
'$ref-value': import("@scalar/typebox").TOptional<import("@scalar/typebox").TRef<"PathItemObject">>;
|
|
135
135
|
}>]>]>>>;
|
|
136
136
|
/** An object to hold reusable Media Type Objects. Added in OpenAPI 3.2. */
|
|
137
137
|
mediaTypes: import("@scalar/typebox").TOptional<import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"MediaTypeObject">, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
|
|
@@ -142,7 +142,7 @@ export declare const ComponentsObjectSchemaDefinition: import("@scalar/typebox")
|
|
|
142
142
|
$status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
|
|
143
143
|
$global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
144
144
|
}>]>, import("@scalar/typebox").TObject<{
|
|
145
|
-
'$ref-value': import("@scalar/typebox").TRef<"MediaTypeObject"
|
|
145
|
+
'$ref-value': import("@scalar/typebox").TOptional<import("@scalar/typebox").TRef<"MediaTypeObject">>;
|
|
146
146
|
}>]>]>>>;
|
|
147
147
|
}>;
|
|
148
148
|
/** Holds a set of reusable objects for different aspects of the OAS. All objects defined within the Components Object will have no effect on the API unless they are explicitly referenced from outside the Components Object. */
|
|
@@ -19,7 +19,7 @@ export declare const EncodingObjectSchemaDefinition: import("@scalar/typebox").T
|
|
|
19
19
|
$status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
|
|
20
20
|
$global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
21
21
|
}>]>, import("@scalar/typebox").TObject<{
|
|
22
|
-
'$ref-value': import("@scalar/typebox").TRef<"HeaderObject"
|
|
22
|
+
'$ref-value': import("@scalar/typebox").TOptional<import("@scalar/typebox").TRef<"HeaderObject">>;
|
|
23
23
|
}>]>]>>>;
|
|
24
24
|
/** Describes how a specific property value will be serialized depending on its type. See the Parameter Object for details on the style field. The behavior follows the same values as query parameters, including default values. Valid values are "form", "spaceDelimited", "pipeDelimited", and "deepObject". This field SHALL be ignored if the request body media type is not application/x-www-form-urlencoded or multipart/form-data. If a value is explicitly defined, then the value of contentType (implicit or explicit) SHALL be ignored. */
|
|
25
25
|
style: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"form">, import("@scalar/typebox").TLiteral<"spaceDelimited">, import("@scalar/typebox").TLiteral<"pipeDelimited">, import("@scalar/typebox").TLiteral<"deepObject">]>>;
|
|
@@ -54,7 +54,7 @@ export declare const HeaderObjectSchemaDefinition: import("@scalar/typebox").TUn
|
|
|
54
54
|
$status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
|
|
55
55
|
$global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
56
56
|
}>]>, import("@scalar/typebox").TObject<{
|
|
57
|
-
'$ref-value': import("@scalar/typebox").TRef<"SchemaObject"
|
|
57
|
+
'$ref-value': import("@scalar/typebox").TOptional<import("@scalar/typebox").TRef<"SchemaObject">>;
|
|
58
58
|
}>]>]>>;
|
|
59
59
|
/** Example of the header's potential value; see Working With Examples. https://swagger.io/specification/#working-with-examples */
|
|
60
60
|
example: import("@scalar/typebox").TOptional<import("@scalar/typebox").TAny>;
|
|
@@ -67,7 +67,7 @@ export declare const HeaderObjectSchemaDefinition: import("@scalar/typebox").TUn
|
|
|
67
67
|
$status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
|
|
68
68
|
$global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
69
69
|
}>]>, import("@scalar/typebox").TObject<{
|
|
70
|
-
'$ref-value': import("@scalar/typebox").TRef<"ExampleObject"
|
|
70
|
+
'$ref-value': import("@scalar/typebox").TOptional<import("@scalar/typebox").TRef<"ExampleObject">>;
|
|
71
71
|
}>]>]>>>;
|
|
72
72
|
}>]>, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
|
|
73
73
|
/** A brief description of the header. This could contain examples of use. CommonMark syntax MAY be used for rich text representation. */
|
|
@@ -19,7 +19,7 @@ export declare const MediaTypeObjectSchemaDefinition: import("@scalar/typebox").
|
|
|
19
19
|
$status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
|
|
20
20
|
$global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
21
21
|
}>]>, import("@scalar/typebox").TObject<{
|
|
22
|
-
'$ref-value': import("@scalar/typebox").TRef<"SchemaObject"
|
|
22
|
+
'$ref-value': import("@scalar/typebox").TOptional<import("@scalar/typebox").TRef<"SchemaObject">>;
|
|
23
23
|
}>]>]>>;
|
|
24
24
|
/** A schema describing each item within a sequential media type. Added in OpenAPI 3.2. */
|
|
25
25
|
itemSchema: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"SchemaObject">, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
|
|
@@ -30,7 +30,7 @@ export declare const MediaTypeObjectSchemaDefinition: import("@scalar/typebox").
|
|
|
30
30
|
$status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
|
|
31
31
|
$global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
32
32
|
}>]>, import("@scalar/typebox").TObject<{
|
|
33
|
-
'$ref-value': import("@scalar/typebox").TRef<"SchemaObject"
|
|
33
|
+
'$ref-value': import("@scalar/typebox").TOptional<import("@scalar/typebox").TRef<"SchemaObject">>;
|
|
34
34
|
}>]>]>>;
|
|
35
35
|
/** Example of the media type */
|
|
36
36
|
example: import("@scalar/typebox").TOptional<import("@scalar/typebox").TAny>;
|
|
@@ -43,7 +43,7 @@ export declare const MediaTypeObjectSchemaDefinition: import("@scalar/typebox").
|
|
|
43
43
|
$status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
|
|
44
44
|
$global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
45
45
|
}>]>, import("@scalar/typebox").TObject<{
|
|
46
|
-
'$ref-value': import("@scalar/typebox").TRef<"ExampleObject"
|
|
46
|
+
'$ref-value': import("@scalar/typebox").TOptional<import("@scalar/typebox").TRef<"ExampleObject">>;
|
|
47
47
|
}>]>]>>>;
|
|
48
48
|
/** A map between a property name and its encoding information. The key, being the property name, MUST exist in the schema as a property. The encoding field SHALL only apply to Request Body Objects, and only when the media type is multipart or application/x-www-form-urlencoded. If no Encoding Object is provided for a property, the behavior is determined by the default values documented for the Encoding Object. */
|
|
49
49
|
encoding: import("@scalar/typebox").TOptional<import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TRef<"EncodingObject">>>;
|