@scalar/workspace-store 0.56.0 → 0.57.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 +29 -0
- package/dist/client.d.ts.map +1 -1
- package/dist/client.js +9 -0
- package/dist/entities/auth/schema.d.ts +220 -20
- package/dist/entities/auth/schema.d.ts.map +1 -1
- package/dist/mutators/operation/helpers/fetch-request-to-har.d.ts.map +1 -1
- package/dist/mutators/operation/helpers/fetch-request-to-har.js +7 -2
- package/dist/navigation/get-navigation-options.d.ts.map +1 -1
- package/dist/navigation/get-navigation-options.js +4 -1
- package/dist/request-example/builder/body/get-request-body-example.d.ts.map +1 -1
- package/dist/request-example/builder/body/get-request-body-example.js +4 -2
- package/dist/schemas/reference-config/index.d.ts +28 -4
- package/dist/schemas/reference-config/index.d.ts.map +1 -1
- package/dist/schemas/reference-config/settings.d.ts +28 -4
- package/dist/schemas/reference-config/settings.d.ts.map +1 -1
- package/dist/schemas/v3.1/strict/oauth-flow.d.ts +19 -1
- package/dist/schemas/v3.1/strict/oauth-flow.d.ts.map +1 -1
- package/dist/schemas/v3.1/strict/oauth-flow.js +6 -1
- package/dist/schemas/v3.1/strict/oauthflows.d.ts +16 -0
- package/dist/schemas/v3.1/strict/oauthflows.d.ts.map +1 -1
- package/dist/schemas/v3.1/strict/openapi-document.d.ts +980 -140
- package/dist/schemas/v3.1/strict/openapi-document.d.ts.map +1 -1
- package/dist/schemas/v3.1/strict/security-scheme.d.ts +14 -5
- package/dist/schemas/v3.1/strict/security-scheme.d.ts.map +1 -1
- package/dist/schemas/v3.1/strict/security-scheme.js +5 -2
- package/dist/schemas/v3.2/openapi/index.d.ts +144 -0
- package/dist/schemas/v3.2/openapi/index.d.ts.map +1 -0
- package/dist/schemas/v3.2/openapi/index.js +713 -0
- package/dist/schemas/v3.2/openapi/reference.d.ts +4 -0
- package/dist/schemas/v3.2/openapi/reference.d.ts.map +1 -0
- package/dist/schemas/v3.2/openapi/reference.js +29 -0
- package/dist/schemas/v3.2/strict/callback.d.ts +15 -0
- package/dist/schemas/v3.2/strict/callback.d.ts.map +1 -0
- package/dist/schemas/v3.2/strict/callback.js +6 -0
- package/dist/schemas/v3.2/strict/components.d.ts +173 -0
- package/dist/schemas/v3.2/strict/components.d.ts.map +1 -0
- package/dist/schemas/v3.2/strict/components.js +29 -0
- package/dist/schemas/v3.2/strict/contact.d.ts +19 -0
- package/dist/schemas/v3.2/strict/contact.d.ts.map +1 -0
- package/dist/schemas/v3.2/strict/contact.js +10 -0
- package/dist/schemas/v3.2/strict/discriminator.d.ts +27 -0
- package/dist/schemas/v3.2/strict/discriminator.d.ts.map +1 -0
- package/dist/schemas/v3.2/strict/discriminator.js +14 -0
- package/dist/schemas/v3.2/strict/encoding.d.ts +62 -0
- package/dist/schemas/v3.2/strict/encoding.d.ts.map +1 -0
- package/dist/schemas/v3.2/strict/encoding.js +33 -0
- package/dist/schemas/v3.2/strict/example.d.ts +50 -0
- package/dist/schemas/v3.2/strict/example.d.ts.map +1 -0
- package/dist/schemas/v3.2/strict/example.js +22 -0
- package/dist/schemas/v3.2/strict/external-documentation.d.ts +15 -0
- package/dist/schemas/v3.2/strict/external-documentation.d.ts.map +1 -0
- package/dist/schemas/v3.2/strict/external-documentation.js +8 -0
- package/dist/schemas/v3.2/strict/header.d.ts +97 -0
- package/dist/schemas/v3.2/strict/header.d.ts.map +1 -0
- package/dist/schemas/v3.2/strict/header.js +39 -0
- package/dist/schemas/v3.2/strict/info.d.ts +54 -0
- package/dist/schemas/v3.2/strict/info.d.ts.map +1 -0
- package/dist/schemas/v3.2/strict/info.js +24 -0
- package/dist/schemas/v3.2/strict/license.d.ts +19 -0
- package/dist/schemas/v3.2/strict/license.d.ts.map +1 -0
- package/dist/schemas/v3.2/strict/license.js +10 -0
- package/dist/schemas/v3.2/strict/link.d.ts +44 -0
- package/dist/schemas/v3.2/strict/link.d.ts.map +1 -0
- package/dist/schemas/v3.2/strict/link.js +23 -0
- package/dist/schemas/v3.2/strict/media-type.d.ts +78 -0
- package/dist/schemas/v3.2/strict/media-type.d.ts.map +1 -0
- package/dist/schemas/v3.2/strict/media-type.js +26 -0
- package/dist/schemas/v3.2/strict/oauth-flow.d.ts +159 -0
- package/dist/schemas/v3.2/strict/oauth-flow.d.ts.map +1 -0
- package/dist/schemas/v3.2/strict/oauth-flow.js +44 -0
- package/dist/schemas/v3.2/strict/oauthflows.d.ts +116 -0
- package/dist/schemas/v3.2/strict/oauthflows.d.ts.map +1 -0
- package/dist/schemas/v3.2/strict/oauthflows.js +17 -0
- package/dist/schemas/v3.2/strict/openapi-document.d.ts +64576 -0
- package/dist/schemas/v3.2/strict/openapi-document.d.ts.map +1 -0
- package/dist/schemas/v3.2/strict/openapi-document.js +154 -0
- package/dist/schemas/v3.2/strict/operation.d.ts +165 -0
- package/dist/schemas/v3.2/strict/operation.d.ts.map +1 -0
- package/dist/schemas/v3.2/strict/operation.js +40 -0
- package/dist/schemas/v3.2/strict/parameter.d.ts +142 -0
- package/dist/schemas/v3.2/strict/parameter.d.ts.map +1 -0
- package/dist/schemas/v3.2/strict/parameter.js +58 -0
- package/dist/schemas/v3.2/strict/path-item.d.ts +189 -0
- package/dist/schemas/v3.2/strict/path-item.d.ts.map +1 -0
- package/dist/schemas/v3.2/strict/path-item.js +41 -0
- package/dist/schemas/v3.2/strict/paths.d.ts +20 -0
- package/dist/schemas/v3.2/strict/paths.d.ts.map +1 -0
- package/dist/schemas/v3.2/strict/paths.js +9 -0
- package/dist/schemas/v3.2/strict/ref-definitions.d.ts +76 -0
- package/dist/schemas/v3.2/strict/ref-definitions.d.ts.map +1 -0
- package/dist/schemas/v3.2/strict/ref-definitions.js +80 -0
- package/dist/schemas/v3.2/strict/reference.d.ts +63 -0
- package/dist/schemas/v3.2/strict/reference.d.ts.map +1 -0
- package/dist/schemas/v3.2/strict/reference.js +23 -0
- package/dist/schemas/v3.2/strict/request-body.d.ts +23 -0
- package/dist/schemas/v3.2/strict/request-body.d.ts.map +1 -0
- package/dist/schemas/v3.2/strict/request-body.js +13 -0
- package/dist/schemas/v3.2/strict/response.d.ts +50 -0
- package/dist/schemas/v3.2/strict/response.d.ts.map +1 -0
- package/dist/schemas/v3.2/strict/response.js +15 -0
- package/dist/schemas/v3.2/strict/responses.d.ts +32 -0
- package/dist/schemas/v3.2/strict/responses.d.ts.map +1 -0
- package/dist/schemas/v3.2/strict/responses.js +13 -0
- package/dist/schemas/v3.2/strict/schema.d.ts +1330 -0
- package/dist/schemas/v3.2/strict/schema.d.ts.map +1 -0
- package/dist/schemas/v3.2/strict/schema.js +205 -0
- package/dist/schemas/v3.2/strict/security-requirement.d.ts +23 -0
- package/dist/schemas/v3.2/strict/security-requirement.d.ts.map +1 -0
- package/dist/schemas/v3.2/strict/security-requirement.js +13 -0
- package/dist/schemas/v3.2/strict/security-scheme.d.ts +95 -0
- package/dist/schemas/v3.2/strict/security-scheme.d.ts.map +1 -0
- package/dist/schemas/v3.2/strict/security-scheme.js +46 -0
- package/dist/schemas/v3.2/strict/server-variable.d.ts +19 -0
- package/dist/schemas/v3.2/strict/server-variable.d.ts.map +1 -0
- package/dist/schemas/v3.2/strict/server-variable.js +10 -0
- package/dist/schemas/v3.2/strict/server.d.ts +24 -0
- package/dist/schemas/v3.2/strict/server.d.ts.map +1 -0
- package/dist/schemas/v3.2/strict/server.js +13 -0
- package/dist/schemas/v3.2/strict/tag.d.ts +44 -0
- package/dist/schemas/v3.2/strict/tag.d.ts.map +1 -0
- package/dist/schemas/v3.2/strict/tag.js +22 -0
- package/dist/schemas/v3.2/strict/type-guards.d.ts +24 -0
- package/dist/schemas/v3.2/strict/type-guards.d.ts.map +1 -0
- package/dist/schemas/v3.2/strict/type-guards.js +25 -0
- package/dist/schemas/v3.2/strict/xml.d.ts +39 -0
- package/dist/schemas/v3.2/strict/xml.d.ts.map +1 -0
- package/dist/schemas/v3.2/strict/xml.js +26 -0
- package/package.json +12 -12
|
@@ -0,0 +1,1330 @@
|
|
|
1
|
+
import { type XInternal } from '../../../schemas/extensions/document/x-internal.js';
|
|
2
|
+
import { type XScalarIgnore } from '../../../schemas/extensions/document/x-scalar-ignore.js';
|
|
3
|
+
import { type XTags } from '../../../schemas/extensions/document/x-tags.js';
|
|
4
|
+
import { type XAdditionalPropertiesName } from '../../../schemas/extensions/schema/x-additional-properties-name.js';
|
|
5
|
+
import { type XEnumDescriptions } from '../../../schemas/extensions/schema/x-enum-descriptions.js';
|
|
6
|
+
import { type XEnumVarNames } from '../../../schemas/extensions/schema/x-enum-varnames.js';
|
|
7
|
+
import { type XExamples } from '../../../schemas/extensions/schema/x-examples.js';
|
|
8
|
+
import { type XOrder } from '../../../schemas/extensions/schema/x-order.js';
|
|
9
|
+
import { type XVariable } from '../../../schemas/extensions/schema/x-variable.js';
|
|
10
|
+
import type { ExternalDocumentationObject } from '../../../schemas/v3.2/strict/external-documentation.js';
|
|
11
|
+
import type { XMLObject } from '../../../schemas/v3.2/strict/xml.js';
|
|
12
|
+
import type { DiscriminatorObject } from './discriminator.js';
|
|
13
|
+
import { type ReferenceObject } from './reference.js';
|
|
14
|
+
export type SchemaReferenceType<Value> = Value | (ReferenceObject & {
|
|
15
|
+
'$ref-value'?: unknown;
|
|
16
|
+
});
|
|
17
|
+
type PrimitiveSchemaType = 'null' | 'boolean' | 'string' | 'number' | 'integer' | 'object' | 'array';
|
|
18
|
+
/** We use this type to ensure that we are parsing a schema object as every property can be optional */
|
|
19
|
+
type _InternalType = CoreProperties & {
|
|
20
|
+
__scalar_: string;
|
|
21
|
+
} & Extensions;
|
|
22
|
+
/**
|
|
23
|
+
* Primitive types that don't have additional validation properties.
|
|
24
|
+
* These types (null, boolean) can be used
|
|
25
|
+
* without additional validation constraints.
|
|
26
|
+
*/
|
|
27
|
+
declare const OtherTypes: import("@scalar/typebox").TObject<{
|
|
28
|
+
type: import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"null">, import("@scalar/typebox").TLiteral<"boolean">]>;
|
|
29
|
+
}>;
|
|
30
|
+
type OtherType = 'boolean' | 'null';
|
|
31
|
+
type OtherTypes = CoreProperties & {
|
|
32
|
+
type: OtherType;
|
|
33
|
+
} & Extensions;
|
|
34
|
+
declare const Extensions: import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
|
|
35
|
+
'x-scalar-ignore': import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
36
|
+
}>, import("@scalar/typebox").TObject<{
|
|
37
|
+
'x-internal': import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
38
|
+
}>, import("@scalar/typebox").TObject<{
|
|
39
|
+
'x-variable': import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
40
|
+
}>, import("@scalar/typebox").TObject<{
|
|
41
|
+
'x-examples': import("@scalar/typebox").TOptional<import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TUnknown>>;
|
|
42
|
+
}>, import("@scalar/typebox").TObject<{
|
|
43
|
+
'x-enumDescriptions': import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TString>, import("@scalar/typebox").TArray<import("@scalar/typebox").TString>]>>;
|
|
44
|
+
'x-enum-descriptions': import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TString>, import("@scalar/typebox").TArray<import("@scalar/typebox").TString>]>>;
|
|
45
|
+
}>, import("@scalar/typebox").TObject<{
|
|
46
|
+
'x-enum-varnames': import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TString>>;
|
|
47
|
+
'x-enumNames': import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TString>>;
|
|
48
|
+
}>, import("@scalar/typebox").TObject<{
|
|
49
|
+
'x-additionalPropertiesName': import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
50
|
+
}>, import("@scalar/typebox").TObject<{
|
|
51
|
+
'x-order': import("@scalar/typebox").TOptional<import("@scalar/typebox").TNumber>;
|
|
52
|
+
}>, import("@scalar/typebox").TObject<{
|
|
53
|
+
'x-tags': import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TString>>;
|
|
54
|
+
}>]>;
|
|
55
|
+
type Extensions = XScalarIgnore & XInternal & XVariable & XEnumDescriptions & XEnumVarNames & XExamples & XAdditionalPropertiesName & XOrder & XTags;
|
|
56
|
+
type CoreProperties = {
|
|
57
|
+
/**
|
|
58
|
+
* JSON Schema 2020-12 core reference keywords.
|
|
59
|
+
*
|
|
60
|
+
* OpenAPI 3.1 adopts the JSON Schema 2020-12 dialect for Schema Objects, which means a schema may carry an
|
|
61
|
+
* identifier (`$id`), a plain-name anchor (`$anchor`), and the dynamic binding keywords (`$dynamicAnchor` /
|
|
62
|
+
* `$dynamicRef`) used for generic and recursive patterns such as `PaginatedResponse<T>`. We keep these typed so
|
|
63
|
+
* the keywords survive parsing instead of being dropped as unknown properties. Resolution of `$dynamicRef`
|
|
64
|
+
* against the active `$dynamicAnchor` is tracked separately, see https://github.com/scalar/scalar/issues/9414.
|
|
65
|
+
*/
|
|
66
|
+
$id?: string;
|
|
67
|
+
/** Plain-name anchor that other schemas can reference with `#anchor`. */
|
|
68
|
+
$anchor?: string;
|
|
69
|
+
/** Dynamic anchor, the target a matching `$dynamicRef` resolves to within the dynamic scope. */
|
|
70
|
+
$dynamicAnchor?: string;
|
|
71
|
+
/** Dynamic reference, resolved against the outermost matching `$dynamicAnchor` in the dynamic scope. */
|
|
72
|
+
$dynamicRef?: string;
|
|
73
|
+
name?: string;
|
|
74
|
+
/** A title for the schema. */
|
|
75
|
+
title?: string;
|
|
76
|
+
/** A description of the schema. */
|
|
77
|
+
description?: string;
|
|
78
|
+
/** Default value for the schema. */
|
|
79
|
+
default?: unknown;
|
|
80
|
+
/** Array of allowed values. */
|
|
81
|
+
enum?: unknown[];
|
|
82
|
+
/** Constant value that must match exactly. */
|
|
83
|
+
const?: unknown;
|
|
84
|
+
/** Media type for content validation. */
|
|
85
|
+
contentMediaType?: string;
|
|
86
|
+
/** Content encoding. */
|
|
87
|
+
contentEncoding?: string;
|
|
88
|
+
/** Schema for content validation. */
|
|
89
|
+
contentSchema?: SchemaReferenceType<SchemaObject>;
|
|
90
|
+
/** Whether the schema is deprecated. */
|
|
91
|
+
deprecated?: boolean;
|
|
92
|
+
/** Adds support for polymorphism. The discriminator is used to determine which of a set of schemas a payload is expected to satisfy. See Composition and Inheritance for more details. */
|
|
93
|
+
discriminator?: DiscriminatorObject;
|
|
94
|
+
/** Whether the schema is read-only. */
|
|
95
|
+
readOnly?: boolean;
|
|
96
|
+
/** Whether the schema is write-only. */
|
|
97
|
+
writeOnly?: boolean;
|
|
98
|
+
/** This MAY be used only on property schemas. It has no effect on root schemas. Adds additional metadata to describe the XML representation of this property. */
|
|
99
|
+
xml?: XMLObject;
|
|
100
|
+
/** Additional external documentation for this schema. */
|
|
101
|
+
externalDocs?: ExternalDocumentationObject;
|
|
102
|
+
/**
|
|
103
|
+
* A free-form field to include an example of an instance for this schema. To represent examples that cannot be naturally represented in JSON or YAML, a string value can be used to contain the example with escaping where necessary.
|
|
104
|
+
*
|
|
105
|
+
* @deprecated The example field has been deprecated in favor of the JSON Schema examples keyword. Use of example is discouraged, and later versions of this specification may remove it.
|
|
106
|
+
*/
|
|
107
|
+
example?: unknown;
|
|
108
|
+
/**
|
|
109
|
+
* An array of examples of valid instances for this schema. This keyword follows the JSON Schema Draft 2020-12 specification.
|
|
110
|
+
* Each example should be a valid instance of the schema.
|
|
111
|
+
*/
|
|
112
|
+
examples?: unknown[];
|
|
113
|
+
/** All schemas must be valid. */
|
|
114
|
+
allOf?: SchemaReferenceType<SchemaObject>[];
|
|
115
|
+
/** Exactly one schema must be valid. */
|
|
116
|
+
oneOf?: SchemaReferenceType<SchemaObject>[];
|
|
117
|
+
/** At least one schema must be valid. */
|
|
118
|
+
anyOf?: SchemaReferenceType<SchemaObject>[];
|
|
119
|
+
/** Schema must not be valid. */
|
|
120
|
+
not?: SchemaReferenceType<SchemaObject>;
|
|
121
|
+
};
|
|
122
|
+
type NumericKeywords = {
|
|
123
|
+
/** Number must be a multiple of this value. */
|
|
124
|
+
multipleOf?: number;
|
|
125
|
+
/** Maximum value (inclusive). */
|
|
126
|
+
maximum?: number;
|
|
127
|
+
/** Maximum value (exclusive). */
|
|
128
|
+
exclusiveMaximum?: number;
|
|
129
|
+
/** Minimum value (inclusive). */
|
|
130
|
+
minimum?: number;
|
|
131
|
+
/** Minimum value (exclusive). */
|
|
132
|
+
exclusiveMinimum?: number;
|
|
133
|
+
};
|
|
134
|
+
type NumericFormat = 'int8' | 'int16' | 'int32' | 'int64' | 'uint8' | 'uint16' | 'uint32' | 'uint64' | 'double-int' | 'float' | 'double' | 'decimal' | 'decimal128' | 'sf-integer' | 'sf-decimal' | (string & {});
|
|
135
|
+
type NumericObject = CoreProperties & NumericKeywords & {
|
|
136
|
+
type: 'number' | 'integer';
|
|
137
|
+
/** Different subtypes */
|
|
138
|
+
format?: NumericFormat;
|
|
139
|
+
} & Extensions;
|
|
140
|
+
/**
|
|
141
|
+
* Supported string formats in OpenAPI schemas.
|
|
142
|
+
*
|
|
143
|
+
* These provide better type safety for string format validation. We wanted to allow any arbitrary string
|
|
144
|
+
* in the schema, so we type it in typescript instead. This gives us autocomplete while allowing any string!
|
|
145
|
+
*/
|
|
146
|
+
type StringFormat = 'date' | 'date-time' | 'date-time-local' | 'time' | 'time-local' | 'duration' | 'http-date' | 'email' | 'idn-email' | 'hostname' | 'idn-hostname' | 'ipv4' | 'ipv6' | 'uri' | 'uri-reference' | 'uri-template' | 'iri' | 'iri-reference' | 'uuid' | 'binary' | 'byte' | 'base64url' | 'html' | 'commonmark' | 'password' | 'regex' | 'json-pointer' | 'relative-json-pointer' | 'media-range' | 'char' | 'sf-string' | 'sf-token' | 'sf-binary' | 'sf-boolean' | (string & {});
|
|
147
|
+
type StringKeywords = {
|
|
148
|
+
/** Maximum string length. */
|
|
149
|
+
maxLength?: number;
|
|
150
|
+
/** Minimum string length. */
|
|
151
|
+
minLength?: number;
|
|
152
|
+
/** Regular expression pattern. */
|
|
153
|
+
pattern?: string;
|
|
154
|
+
};
|
|
155
|
+
type StringObject = CoreProperties & StringKeywords & {
|
|
156
|
+
type: 'string';
|
|
157
|
+
/** Different subtypes - allow any arbitrary string, this negates the purpose of having a union of formats so we type it in typescript instead */
|
|
158
|
+
format?: StringFormat;
|
|
159
|
+
} & Extensions;
|
|
160
|
+
type ArrayKeywords = {
|
|
161
|
+
/** Maximum number of items in array. */
|
|
162
|
+
maxItems?: number;
|
|
163
|
+
/** Minimum number of items in array. */
|
|
164
|
+
minItems?: number;
|
|
165
|
+
/** Whether array items must be unique. */
|
|
166
|
+
uniqueItems?: boolean;
|
|
167
|
+
/** Schema for array items. */
|
|
168
|
+
items?: SchemaReferenceType<SchemaObject>;
|
|
169
|
+
/** Schema for tuple validation. */
|
|
170
|
+
prefixItems?: SchemaReferenceType<SchemaObject>[];
|
|
171
|
+
};
|
|
172
|
+
type ArrayObject = CoreProperties & ArrayKeywords & {
|
|
173
|
+
type: 'array';
|
|
174
|
+
} & Extensions;
|
|
175
|
+
type ObjectKeywords = {
|
|
176
|
+
/** Maximum number of properties. */
|
|
177
|
+
maxProperties?: number;
|
|
178
|
+
/** Minimum number of properties. */
|
|
179
|
+
minProperties?: number;
|
|
180
|
+
/** Array of required property names. */
|
|
181
|
+
required?: string[];
|
|
182
|
+
/** Object property definitions. */
|
|
183
|
+
properties?: Record<string, SchemaReferenceType<SchemaObject>>;
|
|
184
|
+
/** Schema for additional properties. */
|
|
185
|
+
additionalProperties?: boolean | SchemaReferenceType<SchemaObject>;
|
|
186
|
+
/** Properties matching regex patterns. */
|
|
187
|
+
patternProperties?: Record<string, SchemaReferenceType<SchemaObject>>;
|
|
188
|
+
/** Constraints on property names (JSON Schema propertyNames keyword). */
|
|
189
|
+
propertyNames?: SchemaReferenceType<SchemaObject>;
|
|
190
|
+
};
|
|
191
|
+
type ObjectObject = CoreProperties & ObjectKeywords & {
|
|
192
|
+
type: 'object';
|
|
193
|
+
} & Extensions;
|
|
194
|
+
type MultiTypeObject = CoreProperties & NumericKeywords & StringKeywords & ArrayKeywords & ObjectKeywords & {
|
|
195
|
+
type: PrimitiveSchemaType[];
|
|
196
|
+
/** Different subtypes - allow any arbitrary string, this negates the purpose of having a union of formats so we type it in typescript instead */
|
|
197
|
+
format?: StringFormat | NumericFormat;
|
|
198
|
+
} & Extensions;
|
|
199
|
+
/** Builds the recursive schema schema */
|
|
200
|
+
export declare const SchemaObjectSchemaDefinition: import("@scalar/typebox").TUnion<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
|
|
201
|
+
__scalar_: import("@scalar/typebox").TString;
|
|
202
|
+
}>, import("@scalar/typebox").TObject<{
|
|
203
|
+
/**
|
|
204
|
+
* JSON Schema 2020-12 core reference keywords.
|
|
205
|
+
*
|
|
206
|
+
* OpenAPI 3.1 adopts the JSON Schema 2020-12 dialect for Schema Objects, which means a schema may carry an
|
|
207
|
+
* identifier (`$id`), a plain-name anchor (`$anchor`), and the dynamic binding keywords (`$dynamicAnchor` /
|
|
208
|
+
* `$dynamicRef`) used for generic and recursive patterns such as `PaginatedResponse<T>`. We keep these typed so
|
|
209
|
+
* the keywords survive parsing instead of being dropped as unknown properties. Resolution of `$dynamicRef`
|
|
210
|
+
* against the active `$dynamicAnchor` is tracked separately, see https://github.com/scalar/scalar/issues/9414.
|
|
211
|
+
*/
|
|
212
|
+
$id: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
213
|
+
/** Plain-name anchor that other schemas can reference with `#anchor`. */
|
|
214
|
+
$anchor: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
215
|
+
/** Dynamic anchor, the target a matching `$dynamicRef` resolves to within the dynamic scope. */
|
|
216
|
+
$dynamicAnchor: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
217
|
+
/** Dynamic reference, resolved against the outermost matching `$dynamicAnchor` in the dynamic scope. */
|
|
218
|
+
$dynamicRef: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
219
|
+
name: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
220
|
+
/** A title for the schema. */
|
|
221
|
+
title: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
222
|
+
/** A description of the schema. */
|
|
223
|
+
description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
224
|
+
/** Default value for the schema. */
|
|
225
|
+
default: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnknown>;
|
|
226
|
+
/** Array of allowed values. */
|
|
227
|
+
enum: import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TUnknown>>;
|
|
228
|
+
/** Constant value that must match exactly. */
|
|
229
|
+
const: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnknown>;
|
|
230
|
+
/** Media type for content validation. */
|
|
231
|
+
contentMediaType: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
232
|
+
/** Content encoding. */
|
|
233
|
+
contentEncoding: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
234
|
+
/** Schema for content validation. */
|
|
235
|
+
contentSchema: 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<{
|
|
236
|
+
$ref: import("@scalar/typebox").TString;
|
|
237
|
+
summary: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
238
|
+
description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
239
|
+
}>, import("@scalar/typebox").TObject<{
|
|
240
|
+
$status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
|
|
241
|
+
$global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
242
|
+
}>]>, import("@scalar/typebox").TObject<{
|
|
243
|
+
'$ref-value': import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnknown>;
|
|
244
|
+
}>]>]>>;
|
|
245
|
+
/** Whether the schema is deprecated. */
|
|
246
|
+
deprecated: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
247
|
+
/** Adds support for polymorphism. The discriminator is used to determine which of a set of schemas a payload is expected to satisfy. See Composition and Inheritance for more details. */
|
|
248
|
+
discriminator: import("@scalar/typebox").TOptional<import("@scalar/typebox").TRef<"DiscriminatorObject">>;
|
|
249
|
+
/** Whether the schema is read-only. */
|
|
250
|
+
readOnly: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
251
|
+
/** Whether the schema is write-only. */
|
|
252
|
+
writeOnly: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
253
|
+
/** This MAY be used only on property schemas. It has no effect on root schemas. Adds additional metadata to describe the XML representation of this property. */
|
|
254
|
+
xml: import("@scalar/typebox").TOptional<import("@scalar/typebox").TRef<"XMLObject">>;
|
|
255
|
+
/** Additional external documentation for this schema. */
|
|
256
|
+
externalDocs: import("@scalar/typebox").TOptional<import("@scalar/typebox").TRef<"ExternalDocumentationObject">>;
|
|
257
|
+
/**
|
|
258
|
+
* A free-form field to include an example of an instance for this schema. To represent examples that cannot be naturally represented in JSON or YAML, a string value can be used to contain the example with escaping where necessary.
|
|
259
|
+
*
|
|
260
|
+
* @deprecated The example field has been deprecated in favor of the JSON Schema examples keyword. Use of example is discouraged, and later versions of this specification may remove it.
|
|
261
|
+
*/
|
|
262
|
+
example: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnknown>;
|
|
263
|
+
/**
|
|
264
|
+
* An array of examples of valid instances for this schema. This keyword follows the JSON Schema Draft 2020-12 specification.
|
|
265
|
+
* Each example should be a valid instance of the schema.
|
|
266
|
+
*/
|
|
267
|
+
examples: import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TUnknown>>;
|
|
268
|
+
/** All schemas must be valid. */
|
|
269
|
+
allOf: import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"SchemaObject">, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
|
|
270
|
+
$ref: import("@scalar/typebox").TString;
|
|
271
|
+
summary: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
272
|
+
description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
273
|
+
}>, import("@scalar/typebox").TObject<{
|
|
274
|
+
$status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
|
|
275
|
+
$global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
276
|
+
}>]>, import("@scalar/typebox").TObject<{
|
|
277
|
+
'$ref-value': import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnknown>;
|
|
278
|
+
}>]>]>>>;
|
|
279
|
+
/** Exactly one schema must be valid. */
|
|
280
|
+
oneOf: import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"SchemaObject">, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
|
|
281
|
+
$ref: import("@scalar/typebox").TString;
|
|
282
|
+
summary: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
283
|
+
description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
284
|
+
}>, import("@scalar/typebox").TObject<{
|
|
285
|
+
$status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
|
|
286
|
+
$global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
287
|
+
}>]>, import("@scalar/typebox").TObject<{
|
|
288
|
+
'$ref-value': import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnknown>;
|
|
289
|
+
}>]>]>>>;
|
|
290
|
+
/** At least one schema must be valid. */
|
|
291
|
+
anyOf: import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"SchemaObject">, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
|
|
292
|
+
$ref: import("@scalar/typebox").TString;
|
|
293
|
+
summary: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
294
|
+
description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
295
|
+
}>, import("@scalar/typebox").TObject<{
|
|
296
|
+
$status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
|
|
297
|
+
$global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
298
|
+
}>]>, import("@scalar/typebox").TObject<{
|
|
299
|
+
'$ref-value': import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnknown>;
|
|
300
|
+
}>]>]>>>;
|
|
301
|
+
/** Schema must not be valid. */
|
|
302
|
+
not: 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<{
|
|
303
|
+
$ref: import("@scalar/typebox").TString;
|
|
304
|
+
summary: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
305
|
+
description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
306
|
+
}>, import("@scalar/typebox").TObject<{
|
|
307
|
+
$status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
|
|
308
|
+
$global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
309
|
+
}>]>, import("@scalar/typebox").TObject<{
|
|
310
|
+
'$ref-value': import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnknown>;
|
|
311
|
+
}>]>]>>;
|
|
312
|
+
}>, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
|
|
313
|
+
'x-scalar-ignore': import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
314
|
+
}>, import("@scalar/typebox").TObject<{
|
|
315
|
+
'x-internal': import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
316
|
+
}>, import("@scalar/typebox").TObject<{
|
|
317
|
+
'x-variable': import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
318
|
+
}>, import("@scalar/typebox").TObject<{
|
|
319
|
+
'x-examples': import("@scalar/typebox").TOptional<import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TUnknown>>;
|
|
320
|
+
}>, import("@scalar/typebox").TObject<{
|
|
321
|
+
'x-enumDescriptions': import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TString>, import("@scalar/typebox").TArray<import("@scalar/typebox").TString>]>>;
|
|
322
|
+
'x-enum-descriptions': import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TString>, import("@scalar/typebox").TArray<import("@scalar/typebox").TString>]>>;
|
|
323
|
+
}>, import("@scalar/typebox").TObject<{
|
|
324
|
+
'x-enum-varnames': import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TString>>;
|
|
325
|
+
'x-enumNames': import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TString>>;
|
|
326
|
+
}>, import("@scalar/typebox").TObject<{
|
|
327
|
+
'x-additionalPropertiesName': import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
328
|
+
}>, import("@scalar/typebox").TObject<{
|
|
329
|
+
'x-order': import("@scalar/typebox").TOptional<import("@scalar/typebox").TNumber>;
|
|
330
|
+
}>, import("@scalar/typebox").TObject<{
|
|
331
|
+
'x-tags': import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TString>>;
|
|
332
|
+
}>]>]>, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
|
|
333
|
+
type: import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"null">, import("@scalar/typebox").TLiteral<"boolean">]>;
|
|
334
|
+
}>, import("@scalar/typebox").TObject<{
|
|
335
|
+
/**
|
|
336
|
+
* JSON Schema 2020-12 core reference keywords.
|
|
337
|
+
*
|
|
338
|
+
* OpenAPI 3.1 adopts the JSON Schema 2020-12 dialect for Schema Objects, which means a schema may carry an
|
|
339
|
+
* identifier (`$id`), a plain-name anchor (`$anchor`), and the dynamic binding keywords (`$dynamicAnchor` /
|
|
340
|
+
* `$dynamicRef`) used for generic and recursive patterns such as `PaginatedResponse<T>`. We keep these typed so
|
|
341
|
+
* the keywords survive parsing instead of being dropped as unknown properties. Resolution of `$dynamicRef`
|
|
342
|
+
* against the active `$dynamicAnchor` is tracked separately, see https://github.com/scalar/scalar/issues/9414.
|
|
343
|
+
*/
|
|
344
|
+
$id: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
345
|
+
/** Plain-name anchor that other schemas can reference with `#anchor`. */
|
|
346
|
+
$anchor: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
347
|
+
/** Dynamic anchor, the target a matching `$dynamicRef` resolves to within the dynamic scope. */
|
|
348
|
+
$dynamicAnchor: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
349
|
+
/** Dynamic reference, resolved against the outermost matching `$dynamicAnchor` in the dynamic scope. */
|
|
350
|
+
$dynamicRef: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
351
|
+
name: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
352
|
+
/** A title for the schema. */
|
|
353
|
+
title: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
354
|
+
/** A description of the schema. */
|
|
355
|
+
description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
356
|
+
/** Default value for the schema. */
|
|
357
|
+
default: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnknown>;
|
|
358
|
+
/** Array of allowed values. */
|
|
359
|
+
enum: import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TUnknown>>;
|
|
360
|
+
/** Constant value that must match exactly. */
|
|
361
|
+
const: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnknown>;
|
|
362
|
+
/** Media type for content validation. */
|
|
363
|
+
contentMediaType: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
364
|
+
/** Content encoding. */
|
|
365
|
+
contentEncoding: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
366
|
+
/** Schema for content validation. */
|
|
367
|
+
contentSchema: 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<{
|
|
368
|
+
$ref: import("@scalar/typebox").TString;
|
|
369
|
+
summary: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
370
|
+
description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
371
|
+
}>, import("@scalar/typebox").TObject<{
|
|
372
|
+
$status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
|
|
373
|
+
$global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
374
|
+
}>]>, import("@scalar/typebox").TObject<{
|
|
375
|
+
'$ref-value': import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnknown>;
|
|
376
|
+
}>]>]>>;
|
|
377
|
+
/** Whether the schema is deprecated. */
|
|
378
|
+
deprecated: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
379
|
+
/** Adds support for polymorphism. The discriminator is used to determine which of a set of schemas a payload is expected to satisfy. See Composition and Inheritance for more details. */
|
|
380
|
+
discriminator: import("@scalar/typebox").TOptional<import("@scalar/typebox").TRef<"DiscriminatorObject">>;
|
|
381
|
+
/** Whether the schema is read-only. */
|
|
382
|
+
readOnly: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
383
|
+
/** Whether the schema is write-only. */
|
|
384
|
+
writeOnly: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
385
|
+
/** This MAY be used only on property schemas. It has no effect on root schemas. Adds additional metadata to describe the XML representation of this property. */
|
|
386
|
+
xml: import("@scalar/typebox").TOptional<import("@scalar/typebox").TRef<"XMLObject">>;
|
|
387
|
+
/** Additional external documentation for this schema. */
|
|
388
|
+
externalDocs: import("@scalar/typebox").TOptional<import("@scalar/typebox").TRef<"ExternalDocumentationObject">>;
|
|
389
|
+
/**
|
|
390
|
+
* A free-form field to include an example of an instance for this schema. To represent examples that cannot be naturally represented in JSON or YAML, a string value can be used to contain the example with escaping where necessary.
|
|
391
|
+
*
|
|
392
|
+
* @deprecated The example field has been deprecated in favor of the JSON Schema examples keyword. Use of example is discouraged, and later versions of this specification may remove it.
|
|
393
|
+
*/
|
|
394
|
+
example: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnknown>;
|
|
395
|
+
/**
|
|
396
|
+
* An array of examples of valid instances for this schema. This keyword follows the JSON Schema Draft 2020-12 specification.
|
|
397
|
+
* Each example should be a valid instance of the schema.
|
|
398
|
+
*/
|
|
399
|
+
examples: import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TUnknown>>;
|
|
400
|
+
/** All schemas must be valid. */
|
|
401
|
+
allOf: import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"SchemaObject">, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
|
|
402
|
+
$ref: import("@scalar/typebox").TString;
|
|
403
|
+
summary: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
404
|
+
description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
405
|
+
}>, import("@scalar/typebox").TObject<{
|
|
406
|
+
$status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
|
|
407
|
+
$global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
408
|
+
}>]>, import("@scalar/typebox").TObject<{
|
|
409
|
+
'$ref-value': import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnknown>;
|
|
410
|
+
}>]>]>>>;
|
|
411
|
+
/** Exactly one schema must be valid. */
|
|
412
|
+
oneOf: import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"SchemaObject">, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
|
|
413
|
+
$ref: import("@scalar/typebox").TString;
|
|
414
|
+
summary: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
415
|
+
description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
416
|
+
}>, import("@scalar/typebox").TObject<{
|
|
417
|
+
$status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
|
|
418
|
+
$global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
419
|
+
}>]>, import("@scalar/typebox").TObject<{
|
|
420
|
+
'$ref-value': import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnknown>;
|
|
421
|
+
}>]>]>>>;
|
|
422
|
+
/** At least one schema must be valid. */
|
|
423
|
+
anyOf: import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"SchemaObject">, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
|
|
424
|
+
$ref: import("@scalar/typebox").TString;
|
|
425
|
+
summary: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
426
|
+
description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
427
|
+
}>, import("@scalar/typebox").TObject<{
|
|
428
|
+
$status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
|
|
429
|
+
$global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
430
|
+
}>]>, import("@scalar/typebox").TObject<{
|
|
431
|
+
'$ref-value': import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnknown>;
|
|
432
|
+
}>]>]>>>;
|
|
433
|
+
/** Schema must not be valid. */
|
|
434
|
+
not: 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<{
|
|
435
|
+
$ref: import("@scalar/typebox").TString;
|
|
436
|
+
summary: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
437
|
+
description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
438
|
+
}>, import("@scalar/typebox").TObject<{
|
|
439
|
+
$status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
|
|
440
|
+
$global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
441
|
+
}>]>, import("@scalar/typebox").TObject<{
|
|
442
|
+
'$ref-value': import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnknown>;
|
|
443
|
+
}>]>]>>;
|
|
444
|
+
}>, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
|
|
445
|
+
'x-scalar-ignore': import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
446
|
+
}>, import("@scalar/typebox").TObject<{
|
|
447
|
+
'x-internal': import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
448
|
+
}>, import("@scalar/typebox").TObject<{
|
|
449
|
+
'x-variable': import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
450
|
+
}>, import("@scalar/typebox").TObject<{
|
|
451
|
+
'x-examples': import("@scalar/typebox").TOptional<import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TUnknown>>;
|
|
452
|
+
}>, import("@scalar/typebox").TObject<{
|
|
453
|
+
'x-enumDescriptions': import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TString>, import("@scalar/typebox").TArray<import("@scalar/typebox").TString>]>>;
|
|
454
|
+
'x-enum-descriptions': import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TString>, import("@scalar/typebox").TArray<import("@scalar/typebox").TString>]>>;
|
|
455
|
+
}>, import("@scalar/typebox").TObject<{
|
|
456
|
+
'x-enum-varnames': import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TString>>;
|
|
457
|
+
'x-enumNames': import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TString>>;
|
|
458
|
+
}>, import("@scalar/typebox").TObject<{
|
|
459
|
+
'x-additionalPropertiesName': import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
460
|
+
}>, import("@scalar/typebox").TObject<{
|
|
461
|
+
'x-order': import("@scalar/typebox").TOptional<import("@scalar/typebox").TNumber>;
|
|
462
|
+
}>, import("@scalar/typebox").TObject<{
|
|
463
|
+
'x-tags': import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TString>>;
|
|
464
|
+
}>]>]>, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
|
|
465
|
+
type: import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"number">, import("@scalar/typebox").TLiteral<"integer">]>;
|
|
466
|
+
/** Different subtypes */
|
|
467
|
+
format: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
468
|
+
}>, import("@scalar/typebox").TObject<{
|
|
469
|
+
/** Number must be a multiple of this value. */
|
|
470
|
+
multipleOf: import("@scalar/typebox").TOptional<import("@scalar/typebox").TNumber>;
|
|
471
|
+
/** Maximum value (inclusive). */
|
|
472
|
+
maximum: import("@scalar/typebox").TOptional<import("@scalar/typebox").TNumber>;
|
|
473
|
+
/** Maximum value (exclusive). */
|
|
474
|
+
exclusiveMaximum: import("@scalar/typebox").TOptional<import("@scalar/typebox").TNumber>;
|
|
475
|
+
/** Minimum value (inclusive). */
|
|
476
|
+
minimum: import("@scalar/typebox").TOptional<import("@scalar/typebox").TNumber>;
|
|
477
|
+
/** Minimum value (exclusive). */
|
|
478
|
+
exclusiveMinimum: import("@scalar/typebox").TOptional<import("@scalar/typebox").TNumber>;
|
|
479
|
+
}>]>, import("@scalar/typebox").TObject<{
|
|
480
|
+
/**
|
|
481
|
+
* JSON Schema 2020-12 core reference keywords.
|
|
482
|
+
*
|
|
483
|
+
* OpenAPI 3.1 adopts the JSON Schema 2020-12 dialect for Schema Objects, which means a schema may carry an
|
|
484
|
+
* identifier (`$id`), a plain-name anchor (`$anchor`), and the dynamic binding keywords (`$dynamicAnchor` /
|
|
485
|
+
* `$dynamicRef`) used for generic and recursive patterns such as `PaginatedResponse<T>`. We keep these typed so
|
|
486
|
+
* the keywords survive parsing instead of being dropped as unknown properties. Resolution of `$dynamicRef`
|
|
487
|
+
* against the active `$dynamicAnchor` is tracked separately, see https://github.com/scalar/scalar/issues/9414.
|
|
488
|
+
*/
|
|
489
|
+
$id: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
490
|
+
/** Plain-name anchor that other schemas can reference with `#anchor`. */
|
|
491
|
+
$anchor: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
492
|
+
/** Dynamic anchor, the target a matching `$dynamicRef` resolves to within the dynamic scope. */
|
|
493
|
+
$dynamicAnchor: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
494
|
+
/** Dynamic reference, resolved against the outermost matching `$dynamicAnchor` in the dynamic scope. */
|
|
495
|
+
$dynamicRef: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
496
|
+
name: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
497
|
+
/** A title for the schema. */
|
|
498
|
+
title: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
499
|
+
/** A description of the schema. */
|
|
500
|
+
description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
501
|
+
/** Default value for the schema. */
|
|
502
|
+
default: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnknown>;
|
|
503
|
+
/** Array of allowed values. */
|
|
504
|
+
enum: import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TUnknown>>;
|
|
505
|
+
/** Constant value that must match exactly. */
|
|
506
|
+
const: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnknown>;
|
|
507
|
+
/** Media type for content validation. */
|
|
508
|
+
contentMediaType: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
509
|
+
/** Content encoding. */
|
|
510
|
+
contentEncoding: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
511
|
+
/** Schema for content validation. */
|
|
512
|
+
contentSchema: 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<{
|
|
513
|
+
$ref: import("@scalar/typebox").TString;
|
|
514
|
+
summary: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
515
|
+
description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
516
|
+
}>, import("@scalar/typebox").TObject<{
|
|
517
|
+
$status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
|
|
518
|
+
$global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
519
|
+
}>]>, import("@scalar/typebox").TObject<{
|
|
520
|
+
'$ref-value': import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnknown>;
|
|
521
|
+
}>]>]>>;
|
|
522
|
+
/** Whether the schema is deprecated. */
|
|
523
|
+
deprecated: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
524
|
+
/** Adds support for polymorphism. The discriminator is used to determine which of a set of schemas a payload is expected to satisfy. See Composition and Inheritance for more details. */
|
|
525
|
+
discriminator: import("@scalar/typebox").TOptional<import("@scalar/typebox").TRef<"DiscriminatorObject">>;
|
|
526
|
+
/** Whether the schema is read-only. */
|
|
527
|
+
readOnly: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
528
|
+
/** Whether the schema is write-only. */
|
|
529
|
+
writeOnly: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
530
|
+
/** This MAY be used only on property schemas. It has no effect on root schemas. Adds additional metadata to describe the XML representation of this property. */
|
|
531
|
+
xml: import("@scalar/typebox").TOptional<import("@scalar/typebox").TRef<"XMLObject">>;
|
|
532
|
+
/** Additional external documentation for this schema. */
|
|
533
|
+
externalDocs: import("@scalar/typebox").TOptional<import("@scalar/typebox").TRef<"ExternalDocumentationObject">>;
|
|
534
|
+
/**
|
|
535
|
+
* A free-form field to include an example of an instance for this schema. To represent examples that cannot be naturally represented in JSON or YAML, a string value can be used to contain the example with escaping where necessary.
|
|
536
|
+
*
|
|
537
|
+
* @deprecated The example field has been deprecated in favor of the JSON Schema examples keyword. Use of example is discouraged, and later versions of this specification may remove it.
|
|
538
|
+
*/
|
|
539
|
+
example: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnknown>;
|
|
540
|
+
/**
|
|
541
|
+
* An array of examples of valid instances for this schema. This keyword follows the JSON Schema Draft 2020-12 specification.
|
|
542
|
+
* Each example should be a valid instance of the schema.
|
|
543
|
+
*/
|
|
544
|
+
examples: import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TUnknown>>;
|
|
545
|
+
/** All schemas must be valid. */
|
|
546
|
+
allOf: import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"SchemaObject">, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
|
|
547
|
+
$ref: import("@scalar/typebox").TString;
|
|
548
|
+
summary: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
549
|
+
description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
550
|
+
}>, import("@scalar/typebox").TObject<{
|
|
551
|
+
$status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
|
|
552
|
+
$global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
553
|
+
}>]>, import("@scalar/typebox").TObject<{
|
|
554
|
+
'$ref-value': import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnknown>;
|
|
555
|
+
}>]>]>>>;
|
|
556
|
+
/** Exactly one schema must be valid. */
|
|
557
|
+
oneOf: import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"SchemaObject">, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
|
|
558
|
+
$ref: import("@scalar/typebox").TString;
|
|
559
|
+
summary: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
560
|
+
description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
561
|
+
}>, import("@scalar/typebox").TObject<{
|
|
562
|
+
$status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
|
|
563
|
+
$global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
564
|
+
}>]>, import("@scalar/typebox").TObject<{
|
|
565
|
+
'$ref-value': import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnknown>;
|
|
566
|
+
}>]>]>>>;
|
|
567
|
+
/** At least one schema must be valid. */
|
|
568
|
+
anyOf: import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"SchemaObject">, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
|
|
569
|
+
$ref: import("@scalar/typebox").TString;
|
|
570
|
+
summary: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
571
|
+
description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
572
|
+
}>, import("@scalar/typebox").TObject<{
|
|
573
|
+
$status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
|
|
574
|
+
$global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
575
|
+
}>]>, import("@scalar/typebox").TObject<{
|
|
576
|
+
'$ref-value': import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnknown>;
|
|
577
|
+
}>]>]>>>;
|
|
578
|
+
/** Schema must not be valid. */
|
|
579
|
+
not: 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<{
|
|
580
|
+
$ref: import("@scalar/typebox").TString;
|
|
581
|
+
summary: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
582
|
+
description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
583
|
+
}>, import("@scalar/typebox").TObject<{
|
|
584
|
+
$status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
|
|
585
|
+
$global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
586
|
+
}>]>, import("@scalar/typebox").TObject<{
|
|
587
|
+
'$ref-value': import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnknown>;
|
|
588
|
+
}>]>]>>;
|
|
589
|
+
}>, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
|
|
590
|
+
'x-scalar-ignore': import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
591
|
+
}>, import("@scalar/typebox").TObject<{
|
|
592
|
+
'x-internal': import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
593
|
+
}>, import("@scalar/typebox").TObject<{
|
|
594
|
+
'x-variable': import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
595
|
+
}>, import("@scalar/typebox").TObject<{
|
|
596
|
+
'x-examples': import("@scalar/typebox").TOptional<import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TUnknown>>;
|
|
597
|
+
}>, import("@scalar/typebox").TObject<{
|
|
598
|
+
'x-enumDescriptions': import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TString>, import("@scalar/typebox").TArray<import("@scalar/typebox").TString>]>>;
|
|
599
|
+
'x-enum-descriptions': import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TString>, import("@scalar/typebox").TArray<import("@scalar/typebox").TString>]>>;
|
|
600
|
+
}>, import("@scalar/typebox").TObject<{
|
|
601
|
+
'x-enum-varnames': import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TString>>;
|
|
602
|
+
'x-enumNames': import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TString>>;
|
|
603
|
+
}>, import("@scalar/typebox").TObject<{
|
|
604
|
+
'x-additionalPropertiesName': import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
605
|
+
}>, import("@scalar/typebox").TObject<{
|
|
606
|
+
'x-order': import("@scalar/typebox").TOptional<import("@scalar/typebox").TNumber>;
|
|
607
|
+
}>, import("@scalar/typebox").TObject<{
|
|
608
|
+
'x-tags': import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TString>>;
|
|
609
|
+
}>]>]>, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
|
|
610
|
+
type: import("@scalar/typebox").TLiteral<"string">;
|
|
611
|
+
/** Different subtypes - allow any arbitrary string, this negates the purpose of having a union of formats so we type it in typescript instead */
|
|
612
|
+
format: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
613
|
+
}>, import("@scalar/typebox").TObject<{
|
|
614
|
+
/** Maximum string length. */
|
|
615
|
+
maxLength: import("@scalar/typebox").TOptional<import("@scalar/typebox").TInteger>;
|
|
616
|
+
/** Minimum string length. */
|
|
617
|
+
minLength: import("@scalar/typebox").TOptional<import("@scalar/typebox").TInteger>;
|
|
618
|
+
/** Regular expression pattern. */
|
|
619
|
+
pattern: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
620
|
+
}>]>, import("@scalar/typebox").TObject<{
|
|
621
|
+
/**
|
|
622
|
+
* JSON Schema 2020-12 core reference keywords.
|
|
623
|
+
*
|
|
624
|
+
* OpenAPI 3.1 adopts the JSON Schema 2020-12 dialect for Schema Objects, which means a schema may carry an
|
|
625
|
+
* identifier (`$id`), a plain-name anchor (`$anchor`), and the dynamic binding keywords (`$dynamicAnchor` /
|
|
626
|
+
* `$dynamicRef`) used for generic and recursive patterns such as `PaginatedResponse<T>`. We keep these typed so
|
|
627
|
+
* the keywords survive parsing instead of being dropped as unknown properties. Resolution of `$dynamicRef`
|
|
628
|
+
* against the active `$dynamicAnchor` is tracked separately, see https://github.com/scalar/scalar/issues/9414.
|
|
629
|
+
*/
|
|
630
|
+
$id: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
631
|
+
/** Plain-name anchor that other schemas can reference with `#anchor`. */
|
|
632
|
+
$anchor: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
633
|
+
/** Dynamic anchor, the target a matching `$dynamicRef` resolves to within the dynamic scope. */
|
|
634
|
+
$dynamicAnchor: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
635
|
+
/** Dynamic reference, resolved against the outermost matching `$dynamicAnchor` in the dynamic scope. */
|
|
636
|
+
$dynamicRef: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
637
|
+
name: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
638
|
+
/** A title for the schema. */
|
|
639
|
+
title: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
640
|
+
/** A description of the schema. */
|
|
641
|
+
description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
642
|
+
/** Default value for the schema. */
|
|
643
|
+
default: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnknown>;
|
|
644
|
+
/** Array of allowed values. */
|
|
645
|
+
enum: import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TUnknown>>;
|
|
646
|
+
/** Constant value that must match exactly. */
|
|
647
|
+
const: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnknown>;
|
|
648
|
+
/** Media type for content validation. */
|
|
649
|
+
contentMediaType: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
650
|
+
/** Content encoding. */
|
|
651
|
+
contentEncoding: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
652
|
+
/** Schema for content validation. */
|
|
653
|
+
contentSchema: 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<{
|
|
654
|
+
$ref: import("@scalar/typebox").TString;
|
|
655
|
+
summary: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
656
|
+
description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
657
|
+
}>, import("@scalar/typebox").TObject<{
|
|
658
|
+
$status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
|
|
659
|
+
$global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
660
|
+
}>]>, import("@scalar/typebox").TObject<{
|
|
661
|
+
'$ref-value': import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnknown>;
|
|
662
|
+
}>]>]>>;
|
|
663
|
+
/** Whether the schema is deprecated. */
|
|
664
|
+
deprecated: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
665
|
+
/** Adds support for polymorphism. The discriminator is used to determine which of a set of schemas a payload is expected to satisfy. See Composition and Inheritance for more details. */
|
|
666
|
+
discriminator: import("@scalar/typebox").TOptional<import("@scalar/typebox").TRef<"DiscriminatorObject">>;
|
|
667
|
+
/** Whether the schema is read-only. */
|
|
668
|
+
readOnly: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
669
|
+
/** Whether the schema is write-only. */
|
|
670
|
+
writeOnly: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
671
|
+
/** This MAY be used only on property schemas. It has no effect on root schemas. Adds additional metadata to describe the XML representation of this property. */
|
|
672
|
+
xml: import("@scalar/typebox").TOptional<import("@scalar/typebox").TRef<"XMLObject">>;
|
|
673
|
+
/** Additional external documentation for this schema. */
|
|
674
|
+
externalDocs: import("@scalar/typebox").TOptional<import("@scalar/typebox").TRef<"ExternalDocumentationObject">>;
|
|
675
|
+
/**
|
|
676
|
+
* A free-form field to include an example of an instance for this schema. To represent examples that cannot be naturally represented in JSON or YAML, a string value can be used to contain the example with escaping where necessary.
|
|
677
|
+
*
|
|
678
|
+
* @deprecated The example field has been deprecated in favor of the JSON Schema examples keyword. Use of example is discouraged, and later versions of this specification may remove it.
|
|
679
|
+
*/
|
|
680
|
+
example: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnknown>;
|
|
681
|
+
/**
|
|
682
|
+
* An array of examples of valid instances for this schema. This keyword follows the JSON Schema Draft 2020-12 specification.
|
|
683
|
+
* Each example should be a valid instance of the schema.
|
|
684
|
+
*/
|
|
685
|
+
examples: import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TUnknown>>;
|
|
686
|
+
/** All schemas must be valid. */
|
|
687
|
+
allOf: import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"SchemaObject">, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
|
|
688
|
+
$ref: import("@scalar/typebox").TString;
|
|
689
|
+
summary: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
690
|
+
description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
691
|
+
}>, import("@scalar/typebox").TObject<{
|
|
692
|
+
$status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
|
|
693
|
+
$global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
694
|
+
}>]>, import("@scalar/typebox").TObject<{
|
|
695
|
+
'$ref-value': import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnknown>;
|
|
696
|
+
}>]>]>>>;
|
|
697
|
+
/** Exactly one schema must be valid. */
|
|
698
|
+
oneOf: import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"SchemaObject">, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
|
|
699
|
+
$ref: import("@scalar/typebox").TString;
|
|
700
|
+
summary: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
701
|
+
description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
702
|
+
}>, import("@scalar/typebox").TObject<{
|
|
703
|
+
$status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
|
|
704
|
+
$global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
705
|
+
}>]>, import("@scalar/typebox").TObject<{
|
|
706
|
+
'$ref-value': import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnknown>;
|
|
707
|
+
}>]>]>>>;
|
|
708
|
+
/** At least one schema must be valid. */
|
|
709
|
+
anyOf: import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"SchemaObject">, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
|
|
710
|
+
$ref: import("@scalar/typebox").TString;
|
|
711
|
+
summary: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
712
|
+
description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
713
|
+
}>, import("@scalar/typebox").TObject<{
|
|
714
|
+
$status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
|
|
715
|
+
$global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
716
|
+
}>]>, import("@scalar/typebox").TObject<{
|
|
717
|
+
'$ref-value': import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnknown>;
|
|
718
|
+
}>]>]>>>;
|
|
719
|
+
/** Schema must not be valid. */
|
|
720
|
+
not: 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<{
|
|
721
|
+
$ref: import("@scalar/typebox").TString;
|
|
722
|
+
summary: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
723
|
+
description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
724
|
+
}>, import("@scalar/typebox").TObject<{
|
|
725
|
+
$status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
|
|
726
|
+
$global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
727
|
+
}>]>, import("@scalar/typebox").TObject<{
|
|
728
|
+
'$ref-value': import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnknown>;
|
|
729
|
+
}>]>]>>;
|
|
730
|
+
}>, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
|
|
731
|
+
'x-scalar-ignore': import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
732
|
+
}>, import("@scalar/typebox").TObject<{
|
|
733
|
+
'x-internal': import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
734
|
+
}>, import("@scalar/typebox").TObject<{
|
|
735
|
+
'x-variable': import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
736
|
+
}>, import("@scalar/typebox").TObject<{
|
|
737
|
+
'x-examples': import("@scalar/typebox").TOptional<import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TUnknown>>;
|
|
738
|
+
}>, import("@scalar/typebox").TObject<{
|
|
739
|
+
'x-enumDescriptions': import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TString>, import("@scalar/typebox").TArray<import("@scalar/typebox").TString>]>>;
|
|
740
|
+
'x-enum-descriptions': import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TString>, import("@scalar/typebox").TArray<import("@scalar/typebox").TString>]>>;
|
|
741
|
+
}>, import("@scalar/typebox").TObject<{
|
|
742
|
+
'x-enum-varnames': import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TString>>;
|
|
743
|
+
'x-enumNames': import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TString>>;
|
|
744
|
+
}>, import("@scalar/typebox").TObject<{
|
|
745
|
+
'x-additionalPropertiesName': import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
746
|
+
}>, import("@scalar/typebox").TObject<{
|
|
747
|
+
'x-order': import("@scalar/typebox").TOptional<import("@scalar/typebox").TNumber>;
|
|
748
|
+
}>, import("@scalar/typebox").TObject<{
|
|
749
|
+
'x-tags': import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TString>>;
|
|
750
|
+
}>]>]>, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
|
|
751
|
+
type: import("@scalar/typebox").TLiteral<"object">;
|
|
752
|
+
}>, import("@scalar/typebox").TObject<{
|
|
753
|
+
/** Maximum number of properties. */
|
|
754
|
+
maxProperties: import("@scalar/typebox").TOptional<import("@scalar/typebox").TInteger>;
|
|
755
|
+
/** Minimum number of properties. */
|
|
756
|
+
minProperties: import("@scalar/typebox").TOptional<import("@scalar/typebox").TInteger>;
|
|
757
|
+
/** Array of required property names. */
|
|
758
|
+
required: import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TString>>;
|
|
759
|
+
/** Object property definitions. */
|
|
760
|
+
properties: import("@scalar/typebox").TOptional<import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"SchemaObject">, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
|
|
761
|
+
$ref: import("@scalar/typebox").TString;
|
|
762
|
+
summary: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
763
|
+
description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
764
|
+
}>, import("@scalar/typebox").TObject<{
|
|
765
|
+
$status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
|
|
766
|
+
$global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
767
|
+
}>]>, import("@scalar/typebox").TObject<{
|
|
768
|
+
'$ref-value': import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnknown>;
|
|
769
|
+
}>]>]>>>;
|
|
770
|
+
/** Schema for additional properties. */
|
|
771
|
+
additionalProperties: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TBoolean, import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"SchemaObject">, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
|
|
772
|
+
$ref: import("@scalar/typebox").TString;
|
|
773
|
+
summary: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
774
|
+
description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
775
|
+
}>, import("@scalar/typebox").TObject<{
|
|
776
|
+
$status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
|
|
777
|
+
$global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
778
|
+
}>]>, import("@scalar/typebox").TObject<{
|
|
779
|
+
'$ref-value': import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnknown>;
|
|
780
|
+
}>]>]>]>>;
|
|
781
|
+
/** Properties matching regex patterns. */
|
|
782
|
+
patternProperties: import("@scalar/typebox").TOptional<import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"SchemaObject">, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
|
|
783
|
+
$ref: import("@scalar/typebox").TString;
|
|
784
|
+
summary: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
785
|
+
description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
786
|
+
}>, import("@scalar/typebox").TObject<{
|
|
787
|
+
$status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
|
|
788
|
+
$global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
789
|
+
}>]>, import("@scalar/typebox").TObject<{
|
|
790
|
+
'$ref-value': import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnknown>;
|
|
791
|
+
}>]>]>>>;
|
|
792
|
+
/** Constraints on property names (JSON Schema propertyNames keyword). */
|
|
793
|
+
propertyNames: 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<{
|
|
794
|
+
$ref: import("@scalar/typebox").TString;
|
|
795
|
+
summary: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
796
|
+
description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
797
|
+
}>, import("@scalar/typebox").TObject<{
|
|
798
|
+
$status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
|
|
799
|
+
$global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
800
|
+
}>]>, import("@scalar/typebox").TObject<{
|
|
801
|
+
'$ref-value': import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnknown>;
|
|
802
|
+
}>]>]>>;
|
|
803
|
+
}>]>, import("@scalar/typebox").TObject<{
|
|
804
|
+
/**
|
|
805
|
+
* JSON Schema 2020-12 core reference keywords.
|
|
806
|
+
*
|
|
807
|
+
* OpenAPI 3.1 adopts the JSON Schema 2020-12 dialect for Schema Objects, which means a schema may carry an
|
|
808
|
+
* identifier (`$id`), a plain-name anchor (`$anchor`), and the dynamic binding keywords (`$dynamicAnchor` /
|
|
809
|
+
* `$dynamicRef`) used for generic and recursive patterns such as `PaginatedResponse<T>`. We keep these typed so
|
|
810
|
+
* the keywords survive parsing instead of being dropped as unknown properties. Resolution of `$dynamicRef`
|
|
811
|
+
* against the active `$dynamicAnchor` is tracked separately, see https://github.com/scalar/scalar/issues/9414.
|
|
812
|
+
*/
|
|
813
|
+
$id: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
814
|
+
/** Plain-name anchor that other schemas can reference with `#anchor`. */
|
|
815
|
+
$anchor: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
816
|
+
/** Dynamic anchor, the target a matching `$dynamicRef` resolves to within the dynamic scope. */
|
|
817
|
+
$dynamicAnchor: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
818
|
+
/** Dynamic reference, resolved against the outermost matching `$dynamicAnchor` in the dynamic scope. */
|
|
819
|
+
$dynamicRef: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
820
|
+
name: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
821
|
+
/** A title for the schema. */
|
|
822
|
+
title: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
823
|
+
/** A description of the schema. */
|
|
824
|
+
description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
825
|
+
/** Default value for the schema. */
|
|
826
|
+
default: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnknown>;
|
|
827
|
+
/** Array of allowed values. */
|
|
828
|
+
enum: import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TUnknown>>;
|
|
829
|
+
/** Constant value that must match exactly. */
|
|
830
|
+
const: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnknown>;
|
|
831
|
+
/** Media type for content validation. */
|
|
832
|
+
contentMediaType: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
833
|
+
/** Content encoding. */
|
|
834
|
+
contentEncoding: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
835
|
+
/** Schema for content validation. */
|
|
836
|
+
contentSchema: 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<{
|
|
837
|
+
$ref: import("@scalar/typebox").TString;
|
|
838
|
+
summary: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
839
|
+
description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
840
|
+
}>, import("@scalar/typebox").TObject<{
|
|
841
|
+
$status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
|
|
842
|
+
$global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
843
|
+
}>]>, import("@scalar/typebox").TObject<{
|
|
844
|
+
'$ref-value': import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnknown>;
|
|
845
|
+
}>]>]>>;
|
|
846
|
+
/** Whether the schema is deprecated. */
|
|
847
|
+
deprecated: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
848
|
+
/** Adds support for polymorphism. The discriminator is used to determine which of a set of schemas a payload is expected to satisfy. See Composition and Inheritance for more details. */
|
|
849
|
+
discriminator: import("@scalar/typebox").TOptional<import("@scalar/typebox").TRef<"DiscriminatorObject">>;
|
|
850
|
+
/** Whether the schema is read-only. */
|
|
851
|
+
readOnly: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
852
|
+
/** Whether the schema is write-only. */
|
|
853
|
+
writeOnly: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
854
|
+
/** This MAY be used only on property schemas. It has no effect on root schemas. Adds additional metadata to describe the XML representation of this property. */
|
|
855
|
+
xml: import("@scalar/typebox").TOptional<import("@scalar/typebox").TRef<"XMLObject">>;
|
|
856
|
+
/** Additional external documentation for this schema. */
|
|
857
|
+
externalDocs: import("@scalar/typebox").TOptional<import("@scalar/typebox").TRef<"ExternalDocumentationObject">>;
|
|
858
|
+
/**
|
|
859
|
+
* A free-form field to include an example of an instance for this schema. To represent examples that cannot be naturally represented in JSON or YAML, a string value can be used to contain the example with escaping where necessary.
|
|
860
|
+
*
|
|
861
|
+
* @deprecated The example field has been deprecated in favor of the JSON Schema examples keyword. Use of example is discouraged, and later versions of this specification may remove it.
|
|
862
|
+
*/
|
|
863
|
+
example: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnknown>;
|
|
864
|
+
/**
|
|
865
|
+
* An array of examples of valid instances for this schema. This keyword follows the JSON Schema Draft 2020-12 specification.
|
|
866
|
+
* Each example should be a valid instance of the schema.
|
|
867
|
+
*/
|
|
868
|
+
examples: import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TUnknown>>;
|
|
869
|
+
/** All schemas must be valid. */
|
|
870
|
+
allOf: import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"SchemaObject">, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
|
|
871
|
+
$ref: import("@scalar/typebox").TString;
|
|
872
|
+
summary: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
873
|
+
description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
874
|
+
}>, import("@scalar/typebox").TObject<{
|
|
875
|
+
$status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
|
|
876
|
+
$global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
877
|
+
}>]>, import("@scalar/typebox").TObject<{
|
|
878
|
+
'$ref-value': import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnknown>;
|
|
879
|
+
}>]>]>>>;
|
|
880
|
+
/** Exactly one schema must be valid. */
|
|
881
|
+
oneOf: import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"SchemaObject">, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
|
|
882
|
+
$ref: import("@scalar/typebox").TString;
|
|
883
|
+
summary: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
884
|
+
description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
885
|
+
}>, import("@scalar/typebox").TObject<{
|
|
886
|
+
$status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
|
|
887
|
+
$global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
888
|
+
}>]>, import("@scalar/typebox").TObject<{
|
|
889
|
+
'$ref-value': import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnknown>;
|
|
890
|
+
}>]>]>>>;
|
|
891
|
+
/** At least one schema must be valid. */
|
|
892
|
+
anyOf: import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"SchemaObject">, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
|
|
893
|
+
$ref: import("@scalar/typebox").TString;
|
|
894
|
+
summary: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
895
|
+
description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
896
|
+
}>, import("@scalar/typebox").TObject<{
|
|
897
|
+
$status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
|
|
898
|
+
$global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
899
|
+
}>]>, import("@scalar/typebox").TObject<{
|
|
900
|
+
'$ref-value': import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnknown>;
|
|
901
|
+
}>]>]>>>;
|
|
902
|
+
/** Schema must not be valid. */
|
|
903
|
+
not: 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<{
|
|
904
|
+
$ref: import("@scalar/typebox").TString;
|
|
905
|
+
summary: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
906
|
+
description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
907
|
+
}>, import("@scalar/typebox").TObject<{
|
|
908
|
+
$status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
|
|
909
|
+
$global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
910
|
+
}>]>, import("@scalar/typebox").TObject<{
|
|
911
|
+
'$ref-value': import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnknown>;
|
|
912
|
+
}>]>]>>;
|
|
913
|
+
}>, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
|
|
914
|
+
'x-scalar-ignore': import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
915
|
+
}>, import("@scalar/typebox").TObject<{
|
|
916
|
+
'x-internal': import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
917
|
+
}>, import("@scalar/typebox").TObject<{
|
|
918
|
+
'x-variable': import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
919
|
+
}>, import("@scalar/typebox").TObject<{
|
|
920
|
+
'x-examples': import("@scalar/typebox").TOptional<import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TUnknown>>;
|
|
921
|
+
}>, import("@scalar/typebox").TObject<{
|
|
922
|
+
'x-enumDescriptions': import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TString>, import("@scalar/typebox").TArray<import("@scalar/typebox").TString>]>>;
|
|
923
|
+
'x-enum-descriptions': import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TString>, import("@scalar/typebox").TArray<import("@scalar/typebox").TString>]>>;
|
|
924
|
+
}>, import("@scalar/typebox").TObject<{
|
|
925
|
+
'x-enum-varnames': import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TString>>;
|
|
926
|
+
'x-enumNames': import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TString>>;
|
|
927
|
+
}>, import("@scalar/typebox").TObject<{
|
|
928
|
+
'x-additionalPropertiesName': import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
929
|
+
}>, import("@scalar/typebox").TObject<{
|
|
930
|
+
'x-order': import("@scalar/typebox").TOptional<import("@scalar/typebox").TNumber>;
|
|
931
|
+
}>, import("@scalar/typebox").TObject<{
|
|
932
|
+
'x-tags': import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TString>>;
|
|
933
|
+
}>]>]>, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
|
|
934
|
+
type: import("@scalar/typebox").TLiteral<"array">;
|
|
935
|
+
}>, import("@scalar/typebox").TObject<{
|
|
936
|
+
/** Maximum number of items in array. */
|
|
937
|
+
maxItems: import("@scalar/typebox").TOptional<import("@scalar/typebox").TInteger>;
|
|
938
|
+
/** Minimum number of items in array. */
|
|
939
|
+
minItems: import("@scalar/typebox").TOptional<import("@scalar/typebox").TInteger>;
|
|
940
|
+
/** Whether array items must be unique. */
|
|
941
|
+
uniqueItems: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
942
|
+
/** Schema for array items. */
|
|
943
|
+
items: 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<{
|
|
944
|
+
$ref: import("@scalar/typebox").TString;
|
|
945
|
+
summary: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
946
|
+
description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
947
|
+
}>, import("@scalar/typebox").TObject<{
|
|
948
|
+
$status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
|
|
949
|
+
$global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
950
|
+
}>]>, import("@scalar/typebox").TObject<{
|
|
951
|
+
'$ref-value': import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnknown>;
|
|
952
|
+
}>]>]>>;
|
|
953
|
+
/** Schema for tuple validation. */
|
|
954
|
+
prefixItems: import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"SchemaObject">, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
|
|
955
|
+
$ref: import("@scalar/typebox").TString;
|
|
956
|
+
summary: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
957
|
+
description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
958
|
+
}>, import("@scalar/typebox").TObject<{
|
|
959
|
+
$status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
|
|
960
|
+
$global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
961
|
+
}>]>, import("@scalar/typebox").TObject<{
|
|
962
|
+
'$ref-value': import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnknown>;
|
|
963
|
+
}>]>]>>>;
|
|
964
|
+
}>]>, import("@scalar/typebox").TObject<{
|
|
965
|
+
/**
|
|
966
|
+
* JSON Schema 2020-12 core reference keywords.
|
|
967
|
+
*
|
|
968
|
+
* OpenAPI 3.1 adopts the JSON Schema 2020-12 dialect for Schema Objects, which means a schema may carry an
|
|
969
|
+
* identifier (`$id`), a plain-name anchor (`$anchor`), and the dynamic binding keywords (`$dynamicAnchor` /
|
|
970
|
+
* `$dynamicRef`) used for generic and recursive patterns such as `PaginatedResponse<T>`. We keep these typed so
|
|
971
|
+
* the keywords survive parsing instead of being dropped as unknown properties. Resolution of `$dynamicRef`
|
|
972
|
+
* against the active `$dynamicAnchor` is tracked separately, see https://github.com/scalar/scalar/issues/9414.
|
|
973
|
+
*/
|
|
974
|
+
$id: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
975
|
+
/** Plain-name anchor that other schemas can reference with `#anchor`. */
|
|
976
|
+
$anchor: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
977
|
+
/** Dynamic anchor, the target a matching `$dynamicRef` resolves to within the dynamic scope. */
|
|
978
|
+
$dynamicAnchor: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
979
|
+
/** Dynamic reference, resolved against the outermost matching `$dynamicAnchor` in the dynamic scope. */
|
|
980
|
+
$dynamicRef: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
981
|
+
name: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
982
|
+
/** A title for the schema. */
|
|
983
|
+
title: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
984
|
+
/** A description of the schema. */
|
|
985
|
+
description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
986
|
+
/** Default value for the schema. */
|
|
987
|
+
default: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnknown>;
|
|
988
|
+
/** Array of allowed values. */
|
|
989
|
+
enum: import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TUnknown>>;
|
|
990
|
+
/** Constant value that must match exactly. */
|
|
991
|
+
const: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnknown>;
|
|
992
|
+
/** Media type for content validation. */
|
|
993
|
+
contentMediaType: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
994
|
+
/** Content encoding. */
|
|
995
|
+
contentEncoding: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
996
|
+
/** Schema for content validation. */
|
|
997
|
+
contentSchema: 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<{
|
|
998
|
+
$ref: import("@scalar/typebox").TString;
|
|
999
|
+
summary: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
1000
|
+
description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
1001
|
+
}>, import("@scalar/typebox").TObject<{
|
|
1002
|
+
$status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
|
|
1003
|
+
$global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
1004
|
+
}>]>, import("@scalar/typebox").TObject<{
|
|
1005
|
+
'$ref-value': import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnknown>;
|
|
1006
|
+
}>]>]>>;
|
|
1007
|
+
/** Whether the schema is deprecated. */
|
|
1008
|
+
deprecated: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
1009
|
+
/** Adds support for polymorphism. The discriminator is used to determine which of a set of schemas a payload is expected to satisfy. See Composition and Inheritance for more details. */
|
|
1010
|
+
discriminator: import("@scalar/typebox").TOptional<import("@scalar/typebox").TRef<"DiscriminatorObject">>;
|
|
1011
|
+
/** Whether the schema is read-only. */
|
|
1012
|
+
readOnly: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
1013
|
+
/** Whether the schema is write-only. */
|
|
1014
|
+
writeOnly: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
1015
|
+
/** This MAY be used only on property schemas. It has no effect on root schemas. Adds additional metadata to describe the XML representation of this property. */
|
|
1016
|
+
xml: import("@scalar/typebox").TOptional<import("@scalar/typebox").TRef<"XMLObject">>;
|
|
1017
|
+
/** Additional external documentation for this schema. */
|
|
1018
|
+
externalDocs: import("@scalar/typebox").TOptional<import("@scalar/typebox").TRef<"ExternalDocumentationObject">>;
|
|
1019
|
+
/**
|
|
1020
|
+
* A free-form field to include an example of an instance for this schema. To represent examples that cannot be naturally represented in JSON or YAML, a string value can be used to contain the example with escaping where necessary.
|
|
1021
|
+
*
|
|
1022
|
+
* @deprecated The example field has been deprecated in favor of the JSON Schema examples keyword. Use of example is discouraged, and later versions of this specification may remove it.
|
|
1023
|
+
*/
|
|
1024
|
+
example: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnknown>;
|
|
1025
|
+
/**
|
|
1026
|
+
* An array of examples of valid instances for this schema. This keyword follows the JSON Schema Draft 2020-12 specification.
|
|
1027
|
+
* Each example should be a valid instance of the schema.
|
|
1028
|
+
*/
|
|
1029
|
+
examples: import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TUnknown>>;
|
|
1030
|
+
/** All schemas must be valid. */
|
|
1031
|
+
allOf: import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"SchemaObject">, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
|
|
1032
|
+
$ref: import("@scalar/typebox").TString;
|
|
1033
|
+
summary: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
1034
|
+
description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
1035
|
+
}>, import("@scalar/typebox").TObject<{
|
|
1036
|
+
$status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
|
|
1037
|
+
$global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
1038
|
+
}>]>, import("@scalar/typebox").TObject<{
|
|
1039
|
+
'$ref-value': import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnknown>;
|
|
1040
|
+
}>]>]>>>;
|
|
1041
|
+
/** Exactly one schema must be valid. */
|
|
1042
|
+
oneOf: import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"SchemaObject">, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
|
|
1043
|
+
$ref: import("@scalar/typebox").TString;
|
|
1044
|
+
summary: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
1045
|
+
description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
1046
|
+
}>, import("@scalar/typebox").TObject<{
|
|
1047
|
+
$status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
|
|
1048
|
+
$global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
1049
|
+
}>]>, import("@scalar/typebox").TObject<{
|
|
1050
|
+
'$ref-value': import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnknown>;
|
|
1051
|
+
}>]>]>>>;
|
|
1052
|
+
/** At least one schema must be valid. */
|
|
1053
|
+
anyOf: import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"SchemaObject">, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
|
|
1054
|
+
$ref: import("@scalar/typebox").TString;
|
|
1055
|
+
summary: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
1056
|
+
description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
1057
|
+
}>, import("@scalar/typebox").TObject<{
|
|
1058
|
+
$status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
|
|
1059
|
+
$global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
1060
|
+
}>]>, import("@scalar/typebox").TObject<{
|
|
1061
|
+
'$ref-value': import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnknown>;
|
|
1062
|
+
}>]>]>>>;
|
|
1063
|
+
/** Schema must not be valid. */
|
|
1064
|
+
not: 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<{
|
|
1065
|
+
$ref: import("@scalar/typebox").TString;
|
|
1066
|
+
summary: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
1067
|
+
description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
1068
|
+
}>, import("@scalar/typebox").TObject<{
|
|
1069
|
+
$status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
|
|
1070
|
+
$global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
1071
|
+
}>]>, import("@scalar/typebox").TObject<{
|
|
1072
|
+
'$ref-value': import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnknown>;
|
|
1073
|
+
}>]>]>>;
|
|
1074
|
+
}>, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
|
|
1075
|
+
'x-scalar-ignore': import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
1076
|
+
}>, import("@scalar/typebox").TObject<{
|
|
1077
|
+
'x-internal': import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
1078
|
+
}>, import("@scalar/typebox").TObject<{
|
|
1079
|
+
'x-variable': import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
1080
|
+
}>, import("@scalar/typebox").TObject<{
|
|
1081
|
+
'x-examples': import("@scalar/typebox").TOptional<import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TUnknown>>;
|
|
1082
|
+
}>, import("@scalar/typebox").TObject<{
|
|
1083
|
+
'x-enumDescriptions': import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TString>, import("@scalar/typebox").TArray<import("@scalar/typebox").TString>]>>;
|
|
1084
|
+
'x-enum-descriptions': import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TString>, import("@scalar/typebox").TArray<import("@scalar/typebox").TString>]>>;
|
|
1085
|
+
}>, import("@scalar/typebox").TObject<{
|
|
1086
|
+
'x-enum-varnames': import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TString>>;
|
|
1087
|
+
'x-enumNames': import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TString>>;
|
|
1088
|
+
}>, import("@scalar/typebox").TObject<{
|
|
1089
|
+
'x-additionalPropertiesName': import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
1090
|
+
}>, import("@scalar/typebox").TObject<{
|
|
1091
|
+
'x-order': import("@scalar/typebox").TOptional<import("@scalar/typebox").TNumber>;
|
|
1092
|
+
}>, import("@scalar/typebox").TObject<{
|
|
1093
|
+
'x-tags': import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TString>>;
|
|
1094
|
+
}>]>]>, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
|
|
1095
|
+
type: import("@scalar/typebox").TArray<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"null">, import("@scalar/typebox").TLiteral<"boolean">, import("@scalar/typebox").TLiteral<"string">, import("@scalar/typebox").TLiteral<"number">, import("@scalar/typebox").TLiteral<"integer">, import("@scalar/typebox").TLiteral<"object">, import("@scalar/typebox").TLiteral<"array">]>>;
|
|
1096
|
+
/** Different subtypes - allow any arbitrary string, this negates the purpose of having a union of formats so we type it in typescript instead */
|
|
1097
|
+
format: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
1098
|
+
}>, import("@scalar/typebox").TObject<{
|
|
1099
|
+
/** Number must be a multiple of this value. */
|
|
1100
|
+
multipleOf: import("@scalar/typebox").TOptional<import("@scalar/typebox").TNumber>;
|
|
1101
|
+
/** Maximum value (inclusive). */
|
|
1102
|
+
maximum: import("@scalar/typebox").TOptional<import("@scalar/typebox").TNumber>;
|
|
1103
|
+
/** Maximum value (exclusive). */
|
|
1104
|
+
exclusiveMaximum: import("@scalar/typebox").TOptional<import("@scalar/typebox").TNumber>;
|
|
1105
|
+
/** Minimum value (inclusive). */
|
|
1106
|
+
minimum: import("@scalar/typebox").TOptional<import("@scalar/typebox").TNumber>;
|
|
1107
|
+
/** Minimum value (exclusive). */
|
|
1108
|
+
exclusiveMinimum: import("@scalar/typebox").TOptional<import("@scalar/typebox").TNumber>;
|
|
1109
|
+
}>, import("@scalar/typebox").TObject<{
|
|
1110
|
+
/** Maximum string length. */
|
|
1111
|
+
maxLength: import("@scalar/typebox").TOptional<import("@scalar/typebox").TInteger>;
|
|
1112
|
+
/** Minimum string length. */
|
|
1113
|
+
minLength: import("@scalar/typebox").TOptional<import("@scalar/typebox").TInteger>;
|
|
1114
|
+
/** Regular expression pattern. */
|
|
1115
|
+
pattern: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
1116
|
+
}>, import("@scalar/typebox").TObject<{
|
|
1117
|
+
/** Maximum number of items in array. */
|
|
1118
|
+
maxItems: import("@scalar/typebox").TOptional<import("@scalar/typebox").TInteger>;
|
|
1119
|
+
/** Minimum number of items in array. */
|
|
1120
|
+
minItems: import("@scalar/typebox").TOptional<import("@scalar/typebox").TInteger>;
|
|
1121
|
+
/** Whether array items must be unique. */
|
|
1122
|
+
uniqueItems: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
1123
|
+
/** Schema for array items. */
|
|
1124
|
+
items: 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<{
|
|
1125
|
+
$ref: import("@scalar/typebox").TString;
|
|
1126
|
+
summary: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
1127
|
+
description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
1128
|
+
}>, import("@scalar/typebox").TObject<{
|
|
1129
|
+
$status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
|
|
1130
|
+
$global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
1131
|
+
}>]>, import("@scalar/typebox").TObject<{
|
|
1132
|
+
'$ref-value': import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnknown>;
|
|
1133
|
+
}>]>]>>;
|
|
1134
|
+
/** Schema for tuple validation. */
|
|
1135
|
+
prefixItems: import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"SchemaObject">, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
|
|
1136
|
+
$ref: import("@scalar/typebox").TString;
|
|
1137
|
+
summary: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
1138
|
+
description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
1139
|
+
}>, import("@scalar/typebox").TObject<{
|
|
1140
|
+
$status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
|
|
1141
|
+
$global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
1142
|
+
}>]>, import("@scalar/typebox").TObject<{
|
|
1143
|
+
'$ref-value': import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnknown>;
|
|
1144
|
+
}>]>]>>>;
|
|
1145
|
+
}>, import("@scalar/typebox").TObject<{
|
|
1146
|
+
/** Maximum number of properties. */
|
|
1147
|
+
maxProperties: import("@scalar/typebox").TOptional<import("@scalar/typebox").TInteger>;
|
|
1148
|
+
/** Minimum number of properties. */
|
|
1149
|
+
minProperties: import("@scalar/typebox").TOptional<import("@scalar/typebox").TInteger>;
|
|
1150
|
+
/** Array of required property names. */
|
|
1151
|
+
required: import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TString>>;
|
|
1152
|
+
/** Object property definitions. */
|
|
1153
|
+
properties: import("@scalar/typebox").TOptional<import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"SchemaObject">, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
|
|
1154
|
+
$ref: import("@scalar/typebox").TString;
|
|
1155
|
+
summary: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
1156
|
+
description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
1157
|
+
}>, import("@scalar/typebox").TObject<{
|
|
1158
|
+
$status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
|
|
1159
|
+
$global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
1160
|
+
}>]>, import("@scalar/typebox").TObject<{
|
|
1161
|
+
'$ref-value': import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnknown>;
|
|
1162
|
+
}>]>]>>>;
|
|
1163
|
+
/** Schema for additional properties. */
|
|
1164
|
+
additionalProperties: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TBoolean, import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"SchemaObject">, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
|
|
1165
|
+
$ref: import("@scalar/typebox").TString;
|
|
1166
|
+
summary: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
1167
|
+
description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
1168
|
+
}>, import("@scalar/typebox").TObject<{
|
|
1169
|
+
$status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
|
|
1170
|
+
$global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
1171
|
+
}>]>, import("@scalar/typebox").TObject<{
|
|
1172
|
+
'$ref-value': import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnknown>;
|
|
1173
|
+
}>]>]>]>>;
|
|
1174
|
+
/** Properties matching regex patterns. */
|
|
1175
|
+
patternProperties: import("@scalar/typebox").TOptional<import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"SchemaObject">, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
|
|
1176
|
+
$ref: import("@scalar/typebox").TString;
|
|
1177
|
+
summary: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
1178
|
+
description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
1179
|
+
}>, import("@scalar/typebox").TObject<{
|
|
1180
|
+
$status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
|
|
1181
|
+
$global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
1182
|
+
}>]>, import("@scalar/typebox").TObject<{
|
|
1183
|
+
'$ref-value': import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnknown>;
|
|
1184
|
+
}>]>]>>>;
|
|
1185
|
+
/** Constraints on property names (JSON Schema propertyNames keyword). */
|
|
1186
|
+
propertyNames: 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<{
|
|
1187
|
+
$ref: import("@scalar/typebox").TString;
|
|
1188
|
+
summary: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
1189
|
+
description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
1190
|
+
}>, import("@scalar/typebox").TObject<{
|
|
1191
|
+
$status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
|
|
1192
|
+
$global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
1193
|
+
}>]>, import("@scalar/typebox").TObject<{
|
|
1194
|
+
'$ref-value': import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnknown>;
|
|
1195
|
+
}>]>]>>;
|
|
1196
|
+
}>]>, import("@scalar/typebox").TObject<{
|
|
1197
|
+
/**
|
|
1198
|
+
* JSON Schema 2020-12 core reference keywords.
|
|
1199
|
+
*
|
|
1200
|
+
* OpenAPI 3.1 adopts the JSON Schema 2020-12 dialect for Schema Objects, which means a schema may carry an
|
|
1201
|
+
* identifier (`$id`), a plain-name anchor (`$anchor`), and the dynamic binding keywords (`$dynamicAnchor` /
|
|
1202
|
+
* `$dynamicRef`) used for generic and recursive patterns such as `PaginatedResponse<T>`. We keep these typed so
|
|
1203
|
+
* the keywords survive parsing instead of being dropped as unknown properties. Resolution of `$dynamicRef`
|
|
1204
|
+
* against the active `$dynamicAnchor` is tracked separately, see https://github.com/scalar/scalar/issues/9414.
|
|
1205
|
+
*/
|
|
1206
|
+
$id: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
1207
|
+
/** Plain-name anchor that other schemas can reference with `#anchor`. */
|
|
1208
|
+
$anchor: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
1209
|
+
/** Dynamic anchor, the target a matching `$dynamicRef` resolves to within the dynamic scope. */
|
|
1210
|
+
$dynamicAnchor: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
1211
|
+
/** Dynamic reference, resolved against the outermost matching `$dynamicAnchor` in the dynamic scope. */
|
|
1212
|
+
$dynamicRef: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
1213
|
+
name: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
1214
|
+
/** A title for the schema. */
|
|
1215
|
+
title: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
1216
|
+
/** A description of the schema. */
|
|
1217
|
+
description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
1218
|
+
/** Default value for the schema. */
|
|
1219
|
+
default: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnknown>;
|
|
1220
|
+
/** Array of allowed values. */
|
|
1221
|
+
enum: import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TUnknown>>;
|
|
1222
|
+
/** Constant value that must match exactly. */
|
|
1223
|
+
const: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnknown>;
|
|
1224
|
+
/** Media type for content validation. */
|
|
1225
|
+
contentMediaType: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
1226
|
+
/** Content encoding. */
|
|
1227
|
+
contentEncoding: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
1228
|
+
/** Schema for content validation. */
|
|
1229
|
+
contentSchema: 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<{
|
|
1230
|
+
$ref: import("@scalar/typebox").TString;
|
|
1231
|
+
summary: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
1232
|
+
description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
1233
|
+
}>, import("@scalar/typebox").TObject<{
|
|
1234
|
+
$status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
|
|
1235
|
+
$global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
1236
|
+
}>]>, import("@scalar/typebox").TObject<{
|
|
1237
|
+
'$ref-value': import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnknown>;
|
|
1238
|
+
}>]>]>>;
|
|
1239
|
+
/** Whether the schema is deprecated. */
|
|
1240
|
+
deprecated: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
1241
|
+
/** Adds support for polymorphism. The discriminator is used to determine which of a set of schemas a payload is expected to satisfy. See Composition and Inheritance for more details. */
|
|
1242
|
+
discriminator: import("@scalar/typebox").TOptional<import("@scalar/typebox").TRef<"DiscriminatorObject">>;
|
|
1243
|
+
/** Whether the schema is read-only. */
|
|
1244
|
+
readOnly: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
1245
|
+
/** Whether the schema is write-only. */
|
|
1246
|
+
writeOnly: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
1247
|
+
/** This MAY be used only on property schemas. It has no effect on root schemas. Adds additional metadata to describe the XML representation of this property. */
|
|
1248
|
+
xml: import("@scalar/typebox").TOptional<import("@scalar/typebox").TRef<"XMLObject">>;
|
|
1249
|
+
/** Additional external documentation for this schema. */
|
|
1250
|
+
externalDocs: import("@scalar/typebox").TOptional<import("@scalar/typebox").TRef<"ExternalDocumentationObject">>;
|
|
1251
|
+
/**
|
|
1252
|
+
* A free-form field to include an example of an instance for this schema. To represent examples that cannot be naturally represented in JSON or YAML, a string value can be used to contain the example with escaping where necessary.
|
|
1253
|
+
*
|
|
1254
|
+
* @deprecated The example field has been deprecated in favor of the JSON Schema examples keyword. Use of example is discouraged, and later versions of this specification may remove it.
|
|
1255
|
+
*/
|
|
1256
|
+
example: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnknown>;
|
|
1257
|
+
/**
|
|
1258
|
+
* An array of examples of valid instances for this schema. This keyword follows the JSON Schema Draft 2020-12 specification.
|
|
1259
|
+
* Each example should be a valid instance of the schema.
|
|
1260
|
+
*/
|
|
1261
|
+
examples: import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TUnknown>>;
|
|
1262
|
+
/** All schemas must be valid. */
|
|
1263
|
+
allOf: import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"SchemaObject">, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
|
|
1264
|
+
$ref: import("@scalar/typebox").TString;
|
|
1265
|
+
summary: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
1266
|
+
description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
1267
|
+
}>, import("@scalar/typebox").TObject<{
|
|
1268
|
+
$status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
|
|
1269
|
+
$global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
1270
|
+
}>]>, import("@scalar/typebox").TObject<{
|
|
1271
|
+
'$ref-value': import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnknown>;
|
|
1272
|
+
}>]>]>>>;
|
|
1273
|
+
/** Exactly one schema must be valid. */
|
|
1274
|
+
oneOf: import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"SchemaObject">, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
|
|
1275
|
+
$ref: import("@scalar/typebox").TString;
|
|
1276
|
+
summary: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
1277
|
+
description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
1278
|
+
}>, import("@scalar/typebox").TObject<{
|
|
1279
|
+
$status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
|
|
1280
|
+
$global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
1281
|
+
}>]>, import("@scalar/typebox").TObject<{
|
|
1282
|
+
'$ref-value': import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnknown>;
|
|
1283
|
+
}>]>]>>>;
|
|
1284
|
+
/** At least one schema must be valid. */
|
|
1285
|
+
anyOf: import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"SchemaObject">, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
|
|
1286
|
+
$ref: import("@scalar/typebox").TString;
|
|
1287
|
+
summary: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
1288
|
+
description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
1289
|
+
}>, import("@scalar/typebox").TObject<{
|
|
1290
|
+
$status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
|
|
1291
|
+
$global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
1292
|
+
}>]>, import("@scalar/typebox").TObject<{
|
|
1293
|
+
'$ref-value': import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnknown>;
|
|
1294
|
+
}>]>]>>>;
|
|
1295
|
+
/** Schema must not be valid. */
|
|
1296
|
+
not: 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<{
|
|
1297
|
+
$ref: import("@scalar/typebox").TString;
|
|
1298
|
+
summary: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
1299
|
+
description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
1300
|
+
}>, import("@scalar/typebox").TObject<{
|
|
1301
|
+
$status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
|
|
1302
|
+
$global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
1303
|
+
}>]>, import("@scalar/typebox").TObject<{
|
|
1304
|
+
'$ref-value': import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnknown>;
|
|
1305
|
+
}>]>]>>;
|
|
1306
|
+
}>, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
|
|
1307
|
+
'x-scalar-ignore': import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
1308
|
+
}>, import("@scalar/typebox").TObject<{
|
|
1309
|
+
'x-internal': import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
1310
|
+
}>, import("@scalar/typebox").TObject<{
|
|
1311
|
+
'x-variable': import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
1312
|
+
}>, import("@scalar/typebox").TObject<{
|
|
1313
|
+
'x-examples': import("@scalar/typebox").TOptional<import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TUnknown>>;
|
|
1314
|
+
}>, import("@scalar/typebox").TObject<{
|
|
1315
|
+
'x-enumDescriptions': import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TString>, import("@scalar/typebox").TArray<import("@scalar/typebox").TString>]>>;
|
|
1316
|
+
'x-enum-descriptions': import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TString>, import("@scalar/typebox").TArray<import("@scalar/typebox").TString>]>>;
|
|
1317
|
+
}>, import("@scalar/typebox").TObject<{
|
|
1318
|
+
'x-enum-varnames': import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TString>>;
|
|
1319
|
+
'x-enumNames': import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TString>>;
|
|
1320
|
+
}>, import("@scalar/typebox").TObject<{
|
|
1321
|
+
'x-additionalPropertiesName': import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
1322
|
+
}>, import("@scalar/typebox").TObject<{
|
|
1323
|
+
'x-order': import("@scalar/typebox").TOptional<import("@scalar/typebox").TNumber>;
|
|
1324
|
+
}>, import("@scalar/typebox").TObject<{
|
|
1325
|
+
'x-tags': import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TString>>;
|
|
1326
|
+
}>]>]>]>;
|
|
1327
|
+
export type SchemaObject = _InternalType | OtherTypes | MultiTypeObject | NumericObject | StringObject | ObjectObject | ArrayObject;
|
|
1328
|
+
export type MaybeRefSchemaObject = SchemaReferenceType<SchemaObject>;
|
|
1329
|
+
export {};
|
|
1330
|
+
//# sourceMappingURL=schema.d.ts.map
|