@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,80 @@
|
|
|
1
|
+
import { Type } from '@scalar/typebox';
|
|
2
|
+
/**
|
|
3
|
+
* Reference definitions for OpenAPI 3.1 objects.
|
|
4
|
+
* These can be used with Type.Ref to create references to these objects in other schemas.
|
|
5
|
+
*
|
|
6
|
+
* Referencing them this way helps avoid circular dependencies in TypeBox schemas while keeping the overhead performance lower.
|
|
7
|
+
*/
|
|
8
|
+
export const REF_DEFINITIONS = {
|
|
9
|
+
ComponentsObject: 'ComponentsObject',
|
|
10
|
+
SecurityRequirementObject: 'SecurityRequirementObject',
|
|
11
|
+
TagObject: 'TagObject',
|
|
12
|
+
CallbackObject: 'CallbackObject',
|
|
13
|
+
PathsObject: 'PathsObject',
|
|
14
|
+
PathItemObject: 'PathItemObject',
|
|
15
|
+
OperationObject: 'OperationObject',
|
|
16
|
+
SchemaObject: 'SchemaObject',
|
|
17
|
+
EncodingObject: 'EncodingObject',
|
|
18
|
+
HeaderObject: 'HeaderObject',
|
|
19
|
+
MediaTypeObject: 'MediaTypeObject',
|
|
20
|
+
ServerObject: 'ServerObject',
|
|
21
|
+
ExternalDocumentationObject: 'ExternalDocumentationObject',
|
|
22
|
+
InfoObject: 'InfoObject',
|
|
23
|
+
ContactObject: 'ContactObject',
|
|
24
|
+
LicenseObject: 'LicenseObject',
|
|
25
|
+
ResponseObject: 'ResponseObject',
|
|
26
|
+
ResponsesObject: 'ResponsesObject',
|
|
27
|
+
ParameterObject: 'ParameterObject',
|
|
28
|
+
ExampleObject: 'ExampleObject',
|
|
29
|
+
RequestBodyObject: 'RequestBodyObject',
|
|
30
|
+
SecuritySchemeObject: 'SecuritySchemeObject',
|
|
31
|
+
SecuritySchemes: 'SecuritySchemes',
|
|
32
|
+
LinkObject: 'LinkObject',
|
|
33
|
+
XMLObject: 'XMLObject',
|
|
34
|
+
DiscriminatorObject: 'DiscriminatorObject',
|
|
35
|
+
OAuthFlowsObject: 'OAuthFlowsObject',
|
|
36
|
+
ServerVariableObject: 'ServerVariableObject',
|
|
37
|
+
// Navigation schemas
|
|
38
|
+
TraversedDescriptionObject: 'TraversedDescriptionObject',
|
|
39
|
+
TraversedOperationObject: 'TraversedOperationObject',
|
|
40
|
+
TraversedAsyncApiOperationObject: 'TraversedAsyncApiOperationObject',
|
|
41
|
+
TraversedAsyncApiChannelObject: 'TraversedAsyncApiChannelObject',
|
|
42
|
+
TraversedAsyncApiMessageObject: 'TraversedAsyncApiMessageObject',
|
|
43
|
+
TraversedSchemaObject: 'TraversedSchemaObject',
|
|
44
|
+
TraversedWebhookObject: 'TraversedWebhookObject',
|
|
45
|
+
TraversedTagObject: 'TraversedTagObject',
|
|
46
|
+
TraversedEntryObject: 'TraversedEntryObject',
|
|
47
|
+
TraversedDocumentObject: 'TraversedDocumentObject',
|
|
48
|
+
};
|
|
49
|
+
// Type alias for schema definitions
|
|
50
|
+
export const ComponentsObjectRef = Type.Ref(REF_DEFINITIONS.ComponentsObject);
|
|
51
|
+
export const SecurityRequirementObjectRef = Type.Ref(REF_DEFINITIONS.SecurityRequirementObject);
|
|
52
|
+
export const TagObjectRef = Type.Ref(REF_DEFINITIONS.TagObject);
|
|
53
|
+
export const CallbackObjectRef = Type.Ref(REF_DEFINITIONS.CallbackObject);
|
|
54
|
+
export const PathItemObjectRef = Type.Ref(REF_DEFINITIONS.PathItemObject);
|
|
55
|
+
export const PathsObjectRef = Type.Ref(REF_DEFINITIONS.PathsObject);
|
|
56
|
+
export const OperationObjectRef = Type.Ref(REF_DEFINITIONS.OperationObject);
|
|
57
|
+
export const SchemaObjectRef = Type.Ref(REF_DEFINITIONS.SchemaObject);
|
|
58
|
+
export const EncodingObjectRef = Type.Ref(REF_DEFINITIONS.EncodingObject);
|
|
59
|
+
export const HeaderObjectRef = Type.Ref(REF_DEFINITIONS.HeaderObject);
|
|
60
|
+
export const MediaTypeObjectRef = Type.Ref(REF_DEFINITIONS.MediaTypeObject);
|
|
61
|
+
export const ServerObjectRef = Type.Ref(REF_DEFINITIONS.ServerObject);
|
|
62
|
+
export const ExternalDocumentationObjectRef = Type.Ref(REF_DEFINITIONS.ExternalDocumentationObject);
|
|
63
|
+
export const InfoObjectRef = Type.Ref(REF_DEFINITIONS.InfoObject);
|
|
64
|
+
export const ContactObjectRef = Type.Ref(REF_DEFINITIONS.ContactObject);
|
|
65
|
+
export const LicenseObjectRef = Type.Ref(REF_DEFINITIONS.LicenseObject);
|
|
66
|
+
export const ResponseObjectRef = Type.Ref(REF_DEFINITIONS.ResponseObject);
|
|
67
|
+
export const ResponsesObjectRef = Type.Ref(REF_DEFINITIONS.ResponsesObject);
|
|
68
|
+
export const ParameterObjectRef = Type.Ref(REF_DEFINITIONS.ParameterObject);
|
|
69
|
+
export const ExampleObjectRef = Type.Ref(REF_DEFINITIONS.ExampleObject);
|
|
70
|
+
export const RequestBodyObjectRef = Type.Ref(REF_DEFINITIONS.RequestBodyObject);
|
|
71
|
+
export const SecuritySchemeObjectRef = Type.Ref(REF_DEFINITIONS.SecuritySchemeObject);
|
|
72
|
+
export const LinkObjectRef = Type.Ref(REF_DEFINITIONS.LinkObject);
|
|
73
|
+
export const XMLObjectRef = Type.Ref(REF_DEFINITIONS.XMLObject);
|
|
74
|
+
export const DiscriminatorObjectRef = Type.Ref(REF_DEFINITIONS.DiscriminatorObject);
|
|
75
|
+
export const OAuthFlowsObjectRef = Type.Ref(REF_DEFINITIONS.OAuthFlowsObject);
|
|
76
|
+
export const ServerVariableObjectRef = Type.Ref(REF_DEFINITIONS.ServerVariableObject);
|
|
77
|
+
// Navigation schema references
|
|
78
|
+
export const TraversedEntryObjectRef = Type.Ref(REF_DEFINITIONS.TraversedEntryObject);
|
|
79
|
+
// export const TraversedTagObjectRef = Type.Ref(REF_DEFINITIONS.TraversedTagObject)
|
|
80
|
+
export const TraversedDocumentObjectRef = Type.Ref(REF_DEFINITIONS.TraversedDocumentObject);
|
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
import { type TSchema } from '@scalar/typebox';
|
|
2
|
+
export declare const ReferenceObjectExtensionsSchema: import("@scalar/typebox").TObject<{
|
|
3
|
+
/** Indicates the current status of the reference resolution. Can be either 'loading' while fetching the reference or 'error' if the resolution failed. */
|
|
4
|
+
$status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
|
|
5
|
+
/** Indicates whether this reference should be resolved globally across all documents, rather than just within the current document context. */
|
|
6
|
+
$global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
7
|
+
}>;
|
|
8
|
+
/**
|
|
9
|
+
* A simple object to allow referencing other components in the OpenAPI Description, internally and externally.
|
|
10
|
+
*
|
|
11
|
+
* The $ref string value contains a URI RFC3986, which identifies the value being referenced.
|
|
12
|
+
*
|
|
13
|
+
* See the rules for resolving Relative References. */
|
|
14
|
+
export declare const ReferenceObjectSchema: import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
|
|
15
|
+
/** REQUIRED. The reference identifier. This MUST be in the form of a URI. */
|
|
16
|
+
$ref: import("@scalar/typebox").TString;
|
|
17
|
+
/** A short summary which by default SHOULD override that of the referenced component. If the referenced object-type does not allow a summary field, then this field has no effect. */
|
|
18
|
+
summary: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
19
|
+
/** A description which by default SHOULD override that of the referenced component. CommonMark syntax MAY be used for rich text representation. If the referenced object-type does not allow a description field, then this field has no effect. */
|
|
20
|
+
description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
21
|
+
}>, import("@scalar/typebox").TObject<{
|
|
22
|
+
/** Indicates the current status of the reference resolution. Can be either 'loading' while fetching the reference or 'error' if the resolution failed. */
|
|
23
|
+
$status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
|
|
24
|
+
/** Indicates whether this reference should be resolved globally across all documents, rather than just within the current document context. */
|
|
25
|
+
$global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
26
|
+
}>]>;
|
|
27
|
+
/**
|
|
28
|
+
* A simple object to allow referencing other components in the OpenAPI Description, internally and externally.
|
|
29
|
+
*
|
|
30
|
+
* The $ref string value contains a URI RFC3986, which identifies the value being referenced.
|
|
31
|
+
*
|
|
32
|
+
* See the rules for resolving Relative References. */
|
|
33
|
+
export type ReferenceObject = {
|
|
34
|
+
/** REQUIRED. The reference identifier. This MUST be in the form of a URI. */
|
|
35
|
+
'$ref': string;
|
|
36
|
+
/** A short summary which by default SHOULD override that of the referenced component. If the referenced object-type does not allow a summary field, then this field has no effect. */
|
|
37
|
+
summary?: string;
|
|
38
|
+
/** A description which by default SHOULD override that of the referenced component. CommonMark syntax MAY be used for rich text representation. If the referenced object-type does not allow a description field, then this field has no effect. */
|
|
39
|
+
description?: string;
|
|
40
|
+
/** Indicates the current status of the reference resolution. Can be either 'loading' while fetching the reference or 'error' if the resolution failed. */
|
|
41
|
+
'$status'?: 'loading' | 'error';
|
|
42
|
+
/** Indicates whether this reference should be resolved globally across all documents, rather than just within the current document context. */
|
|
43
|
+
'$global'?: boolean;
|
|
44
|
+
};
|
|
45
|
+
export declare const reference: <T extends TSchema>(schema: T) => import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
|
|
46
|
+
/** REQUIRED. The reference identifier. This MUST be in the form of a URI. */
|
|
47
|
+
$ref: import("@scalar/typebox").TString;
|
|
48
|
+
/** A short summary which by default SHOULD override that of the referenced component. If the referenced object-type does not allow a summary field, then this field has no effect. */
|
|
49
|
+
summary: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
50
|
+
/** A description which by default SHOULD override that of the referenced component. CommonMark syntax MAY be used for rich text representation. If the referenced object-type does not allow a description field, then this field has no effect. */
|
|
51
|
+
description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
52
|
+
}>, import("@scalar/typebox").TObject<{
|
|
53
|
+
/** Indicates the current status of the reference resolution. Can be either 'loading' while fetching the reference or 'error' if the resolution failed. */
|
|
54
|
+
$status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
|
|
55
|
+
/** Indicates whether this reference should be resolved globally across all documents, rather than just within the current document context. */
|
|
56
|
+
$global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
57
|
+
}>]>, import("@scalar/typebox").TObject<{
|
|
58
|
+
'$ref-value': T;
|
|
59
|
+
}>]>;
|
|
60
|
+
export type ReferenceType<Value> = Value | (ReferenceObject & {
|
|
61
|
+
'$ref-value': Value;
|
|
62
|
+
});
|
|
63
|
+
//# sourceMappingURL=reference.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"reference.d.ts","sourceRoot":"","sources":["../../../../src/schemas/v3.2/strict/reference.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,OAAO,EAAQ,MAAM,iBAAiB,CAAA;AAIpD,eAAO,MAAM,+BAA+B;IAC1C,0JAA0J;;IAE1J,+IAA+I;;EAE/I,CAAA;AAEF;;;;;sDAKsD;AACtD,eAAO,MAAM,qBAAqB;IAE9B,6EAA6E;;IAE7E,sLAAsL;;IAEtL,oPAAoP;;;IAlBtP,0JAA0J;;IAE1J,+IAA+I;;IAoBhJ,CAAA;AAED;;;;;sDAKsD;AACtD,MAAM,MAAM,eAAe,GAAG;IAC5B,6EAA6E;IAC7E,MAAM,EAAE,MAAM,CAAA;IACd,sLAAsL;IACtL,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,oPAAoP;IACpP,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,0JAA0J;IAC1J,SAAS,CAAC,EAAE,SAAS,GAAG,OAAO,CAAA;IAC/B,+IAA+I;IAC/I,SAAS,CAAC,EAAE,OAAO,CAAA;CACpB,CAAA;AAED,eAAO,MAAM,SAAS,GAAI,CAAC,SAAS,OAAO,EAAE,QAAQ,CAAC;IA7BlD,6EAA6E;;IAE7E,sLAAsL;;IAEtL,oPAAoP;;;IAlBtP,0JAA0J;;IAE1J,+IAA+I;;;;IA0C1E,CAAA;AAEvE,MAAM,MAAM,aAAa,CAAC,KAAK,IAAI,KAAK,GAAG,CAAC,eAAe,GAAG;IAAE,YAAY,EAAE,KAAK,CAAA;CAAE,CAAC,CAAA"}
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
import { Type } from '@scalar/typebox';
|
|
2
|
+
import { compose } from '../../../schemas/compose.js';
|
|
3
|
+
export const ReferenceObjectExtensionsSchema = Type.Object({
|
|
4
|
+
/** Indicates the current status of the reference resolution. Can be either 'loading' while fetching the reference or 'error' if the resolution failed. */
|
|
5
|
+
'$status': Type.Optional(Type.Union([Type.Literal('loading'), Type.Literal('error')])),
|
|
6
|
+
/** Indicates whether this reference should be resolved globally across all documents, rather than just within the current document context. */
|
|
7
|
+
'$global': Type.Optional(Type.Boolean()),
|
|
8
|
+
});
|
|
9
|
+
/**
|
|
10
|
+
* A simple object to allow referencing other components in the OpenAPI Description, internally and externally.
|
|
11
|
+
*
|
|
12
|
+
* The $ref string value contains a URI RFC3986, which identifies the value being referenced.
|
|
13
|
+
*
|
|
14
|
+
* See the rules for resolving Relative References. */
|
|
15
|
+
export const ReferenceObjectSchema = compose(Type.Object({
|
|
16
|
+
/** REQUIRED. The reference identifier. This MUST be in the form of a URI. */
|
|
17
|
+
'$ref': Type.String(),
|
|
18
|
+
/** A short summary which by default SHOULD override that of the referenced component. If the referenced object-type does not allow a summary field, then this field has no effect. */
|
|
19
|
+
summary: Type.Optional(Type.String()),
|
|
20
|
+
/** A description which by default SHOULD override that of the referenced component. CommonMark syntax MAY be used for rich text representation. If the referenced object-type does not allow a description field, then this field has no effect. */
|
|
21
|
+
description: Type.Optional(Type.String()),
|
|
22
|
+
}), ReferenceObjectExtensionsSchema);
|
|
23
|
+
export const reference = (schema) => compose(ReferenceObjectSchema, Type.Object({ '$ref-value': schema }));
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
import { type XScalarSelectedContentType } from '../../../schemas/extensions/operation/x-scalar-selected-content-type.js';
|
|
2
|
+
import type { MediaTypeObject } from './media-type.js';
|
|
3
|
+
/** Describes a single request body. */
|
|
4
|
+
export declare const RequestBodyObjectSchemaDefinition: import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
|
|
5
|
+
/** A brief description of the request body. This could contain examples of use. CommonMark syntax MAY be used for rich text representation. */
|
|
6
|
+
description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
7
|
+
/** REQUIRED. The content of the request body. The key is a media type or media type range and the value describes it. For requests that match multiple keys, only the most specific key is applicable. e.g. "text/plain" overrides "text/* */
|
|
8
|
+
content: import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TRef<"MediaTypeObject">>;
|
|
9
|
+
/** Determines if the request body is required in the request. Defaults to false. */
|
|
10
|
+
required: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
11
|
+
}>, import("@scalar/typebox").TObject<{
|
|
12
|
+
'x-scalar-selected-content-type': import("@scalar/typebox").TOptional<import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TString>>;
|
|
13
|
+
}>]>;
|
|
14
|
+
/** Describes a single request body. */
|
|
15
|
+
export type RequestBodyObject = {
|
|
16
|
+
/** A brief description of the request body. This could contain examples of use. CommonMark syntax MAY be used for rich text representation. */
|
|
17
|
+
description?: string;
|
|
18
|
+
/** REQUIRED. The content of the request body. The key is a media type or media type range and the value describes it. For requests that match multiple keys, only the most specific key is applicable. e.g. "text/plain" overrides "text/* */
|
|
19
|
+
content: Record<string, MediaTypeObject>;
|
|
20
|
+
/** Determines if the request body is required in the request. Defaults to false. */
|
|
21
|
+
required?: boolean;
|
|
22
|
+
} & XScalarSelectedContentType;
|
|
23
|
+
//# sourceMappingURL=request-body.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"request-body.d.ts","sourceRoot":"","sources":["../../../../src/schemas/v3.2/strict/request-body.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,KAAK,0BAA0B,EAEhC,MAAM,+DAA+D,CAAA;AAEtE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,cAAc,CAAA;AAGnD,uCAAuC;AACvC,eAAO,MAAM,iCAAiC;IAE1C,+IAA+I;;IAE/I,8OAA8O;;IAE9O,oFAAoF;;;;IAIvF,CAAA;AAED,uCAAuC;AACvC,MAAM,MAAM,iBAAiB,GAAG;IAC9B,+IAA+I;IAC/I,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,8OAA8O;IAC9O,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAA;IACxC,oFAAoF;IACpF,QAAQ,CAAC,EAAE,OAAO,CAAA;CACnB,GAAG,0BAA0B,CAAA"}
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import { Type } from '@scalar/typebox';
|
|
2
|
+
import { compose } from '../../../schemas/compose.js';
|
|
3
|
+
import { XScalarSelectedContentTypeSchema, } from '../../../schemas/extensions/operation/x-scalar-selected-content-type.js';
|
|
4
|
+
import { MediaTypeObjectRef } from './ref-definitions.js';
|
|
5
|
+
/** Describes a single request body. */
|
|
6
|
+
export const RequestBodyObjectSchemaDefinition = compose(Type.Object({
|
|
7
|
+
/** A brief description of the request body. This could contain examples of use. CommonMark syntax MAY be used for rich text representation. */
|
|
8
|
+
description: Type.Optional(Type.String()),
|
|
9
|
+
/** REQUIRED. The content of the request body. The key is a media type or media type range and the value describes it. For requests that match multiple keys, only the most specific key is applicable. e.g. "text/plain" overrides "text/* */
|
|
10
|
+
content: Type.Record(Type.String(), MediaTypeObjectRef),
|
|
11
|
+
/** Determines if the request body is required in the request. Defaults to false. */
|
|
12
|
+
required: Type.Optional(Type.Boolean()),
|
|
13
|
+
}), XScalarSelectedContentTypeSchema);
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
import type { HeaderObject } from '../../../schemas/v3.2/strict/header.js';
|
|
2
|
+
import type { MediaTypeObject } from '../../../schemas/v3.2/strict/media-type.js';
|
|
3
|
+
import type { LinkObject } from './link.js';
|
|
4
|
+
import { type ReferenceType } from './reference.js';
|
|
5
|
+
export declare const ResponseObjectSchemaDefinition: import("@scalar/typebox").TObject<{
|
|
6
|
+
/** A short summary of the meaning of the response. Added in OpenAPI 3.2. */
|
|
7
|
+
summary: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
8
|
+
/** A description of the response. CommonMark syntax MAY be used for rich text representation. Optional as of OpenAPI 3.2. */
|
|
9
|
+
description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
10
|
+
/** Maps a header name to its definition. RFC7230 states header names are case insensitive. If a response header is defined with the name "Content-Type", it SHALL be ignored. */
|
|
11
|
+
headers: import("@scalar/typebox").TOptional<import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"HeaderObject">, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
|
|
12
|
+
$ref: import("@scalar/typebox").TString;
|
|
13
|
+
summary: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
14
|
+
description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
15
|
+
}>, import("@scalar/typebox").TObject<{
|
|
16
|
+
$status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
|
|
17
|
+
$global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
18
|
+
}>]>, import("@scalar/typebox").TObject<{
|
|
19
|
+
'$ref-value': import("@scalar/typebox").TRef<"HeaderObject">;
|
|
20
|
+
}>]>]>>>;
|
|
21
|
+
/** A map containing descriptions of potential response payloads. The key is a media type or media type range and the value describes it. For responses that match multiple keys, only the most specific key is applicable. e.g. "text/plain" overrides "text/*" */
|
|
22
|
+
content: import("@scalar/typebox").TOptional<import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TRef<"MediaTypeObject">>>;
|
|
23
|
+
/** A map of operations links that can be followed from the response. The key of the map is a short name for the link, following the naming constraints of the names for Component Objects. */
|
|
24
|
+
links: import("@scalar/typebox").TOptional<import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"LinkObject">, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
|
|
25
|
+
$ref: import("@scalar/typebox").TString;
|
|
26
|
+
summary: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
27
|
+
description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
28
|
+
}>, import("@scalar/typebox").TObject<{
|
|
29
|
+
$status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
|
|
30
|
+
$global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
31
|
+
}>]>, import("@scalar/typebox").TObject<{
|
|
32
|
+
'$ref-value': import("@scalar/typebox").TRef<"LinkObject">;
|
|
33
|
+
}>]>]>>>;
|
|
34
|
+
}>;
|
|
35
|
+
/**
|
|
36
|
+
* Describes a single response from an API operation, including design-time, static links to operations based on the response.
|
|
37
|
+
*/
|
|
38
|
+
export type ResponseObject = {
|
|
39
|
+
/** A short summary of the meaning of the response. Added in OpenAPI 3.2. */
|
|
40
|
+
summary?: string;
|
|
41
|
+
/** A description of the response. CommonMark syntax MAY be used for rich text representation. Optional as of OpenAPI 3.2. */
|
|
42
|
+
description?: string;
|
|
43
|
+
/** Maps a header name to its definition. RFC7230 states header names are case insensitive. If a response header is defined with the name "Content-Type", it SHALL be ignored. */
|
|
44
|
+
headers?: Record<string, ReferenceType<HeaderObject>>;
|
|
45
|
+
/** A map containing descriptions of potential response payloads. The key is a media type or media type range and the value describes it. For responses that match multiple keys, only the most specific key is applicable. e.g. "text/plain" overrides "text/*" */
|
|
46
|
+
content?: Record<string, MediaTypeObject>;
|
|
47
|
+
/** A map of operations links that can be followed from the response. The key of the map is a short name for the link, following the naming constraints of the names for Component Objects. */
|
|
48
|
+
links?: Record<string, ReferenceType<LinkObject>>;
|
|
49
|
+
};
|
|
50
|
+
//# sourceMappingURL=response.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"response.d.ts","sourceRoot":"","sources":["../../../../src/schemas/v3.2/strict/response.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAA;AAChE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,kCAAkC,CAAA;AAEvE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAA;AAExC,OAAO,EAAE,KAAK,aAAa,EAAa,MAAM,aAAa,CAAA;AAE3D,eAAO,MAAM,8BAA8B;IACzC,4EAA4E;;IAE5E,6HAA6H;;IAE7H,iLAAiL;;;;;;;;;;;IAEjL,oQAAoQ;;IAEpQ,8LAA8L;;;;;;;;;;;EAE9L,CAAA;AAEF;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,4EAA4E;IAC5E,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,6HAA6H;IAC7H,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,iLAAiL;IACjL,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,YAAY,CAAC,CAAC,CAAA;IACrD,oQAAoQ;IACpQ,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAA;IACzC,8LAA8L;IAC9L,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,UAAU,CAAC,CAAC,CAAA;CAClD,CAAA"}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import { Type } from '@scalar/typebox';
|
|
2
|
+
import { HeaderObjectRef, LinkObjectRef, MediaTypeObjectRef } from './ref-definitions.js';
|
|
3
|
+
import { reference } from './reference.js';
|
|
4
|
+
export const ResponseObjectSchemaDefinition = Type.Object({
|
|
5
|
+
/** A short summary of the meaning of the response. Added in OpenAPI 3.2. */
|
|
6
|
+
summary: Type.Optional(Type.String()),
|
|
7
|
+
/** A description of the response. CommonMark syntax MAY be used for rich text representation. Optional as of OpenAPI 3.2. */
|
|
8
|
+
description: Type.Optional(Type.String()),
|
|
9
|
+
/** Maps a header name to its definition. RFC7230 states header names are case insensitive. If a response header is defined with the name "Content-Type", it SHALL be ignored. */
|
|
10
|
+
headers: Type.Optional(Type.Record(Type.String(), Type.Union([HeaderObjectRef, reference(HeaderObjectRef)]))),
|
|
11
|
+
/** A map containing descriptions of potential response payloads. The key is a media type or media type range and the value describes it. For responses that match multiple keys, only the most specific key is applicable. e.g. "text/plain" overrides "text/*" */
|
|
12
|
+
content: Type.Optional(Type.Record(Type.String(), MediaTypeObjectRef)),
|
|
13
|
+
/** A map of operations links that can be followed from the response. The key of the map is a short name for the link, following the naming constraints of the names for Component Objects. */
|
|
14
|
+
links: Type.Optional(Type.Record(Type.String(), Type.Union([LinkObjectRef, reference(LinkObjectRef)]))),
|
|
15
|
+
});
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
import { type ReferenceType } from './reference.js';
|
|
2
|
+
import type { ResponseObject } from './response.js';
|
|
3
|
+
/**
|
|
4
|
+
* A container for the expected responses of an operation. The container maps a HTTP response code to the expected response.
|
|
5
|
+
*
|
|
6
|
+
* The documentation is not necessarily expected to cover all possible HTTP response codes because they may not be known in advance. However, documentation is expected to cover a successful operation response and any known errors.
|
|
7
|
+
*
|
|
8
|
+
* The default MAY be used as a default Response Object for all HTTP codes that are not covered individually by the Responses Object.
|
|
9
|
+
*
|
|
10
|
+
* The Responses Object MUST contain at least one response code, and if only one response code is provided it SHOULD be the response for a successful operation call.
|
|
11
|
+
*/
|
|
12
|
+
export declare const ResponsesObjectSchemaDefinition: import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"ResponseObject">, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
|
|
13
|
+
$ref: import("@scalar/typebox").TString;
|
|
14
|
+
summary: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
15
|
+
description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
16
|
+
}>, import("@scalar/typebox").TObject<{
|
|
17
|
+
$status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
|
|
18
|
+
$global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
19
|
+
}>]>, import("@scalar/typebox").TObject<{
|
|
20
|
+
'$ref-value': import("@scalar/typebox").TRef<"ResponseObject">;
|
|
21
|
+
}>]>]>>;
|
|
22
|
+
/**
|
|
23
|
+
* A container for the expected responses of an operation. The container maps a HTTP response code to the expected response.
|
|
24
|
+
*
|
|
25
|
+
* The documentation is not necessarily expected to cover all possible HTTP response codes because they may not be known in advance. However, documentation is expected to cover a successful operation response and any known errors.
|
|
26
|
+
*
|
|
27
|
+
* The default MAY be used as a default Response Object for all HTTP codes that are not covered individually by the Responses Object.
|
|
28
|
+
*
|
|
29
|
+
* The Responses Object MUST contain at least one response code, and if only one response code is provided it SHOULD be the response for a successful operation call.
|
|
30
|
+
*/
|
|
31
|
+
export type ResponsesObject = Record<string, ReferenceType<ResponseObject>>;
|
|
32
|
+
//# sourceMappingURL=responses.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"responses.d.ts","sourceRoot":"","sources":["../../../../src/schemas/v3.2/strict/responses.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,KAAK,aAAa,EAAa,MAAM,aAAa,CAAA;AAC3D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,YAAY,CAAA;AAEhD;;;;;;;;GAQG;AACH,eAAO,MAAM,+BAA+B;;;;;;;;;OAG3C,CAAA;AAED;;;;;;;;GAQG;AACH,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,cAAc,CAAC,CAAC,CAAA"}
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import { Type } from '@scalar/typebox';
|
|
2
|
+
import { ResponseObjectRef } from './ref-definitions.js';
|
|
3
|
+
import { reference } from './reference.js';
|
|
4
|
+
/**
|
|
5
|
+
* A container for the expected responses of an operation. The container maps a HTTP response code to the expected response.
|
|
6
|
+
*
|
|
7
|
+
* The documentation is not necessarily expected to cover all possible HTTP response codes because they may not be known in advance. However, documentation is expected to cover a successful operation response and any known errors.
|
|
8
|
+
*
|
|
9
|
+
* The default MAY be used as a default Response Object for all HTTP codes that are not covered individually by the Responses Object.
|
|
10
|
+
*
|
|
11
|
+
* The Responses Object MUST contain at least one response code, and if only one response code is provided it SHOULD be the response for a successful operation call.
|
|
12
|
+
*/
|
|
13
|
+
export const ResponsesObjectSchemaDefinition = Type.Record(Type.String(), Type.Union([ResponseObjectRef, reference(ResponseObjectRef)]));
|