@scalar/workspace-store 0.1.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/.turbo/turbo-build.log +10 -0
- package/CHANGELOG.md +13 -0
- package/README.md +199 -0
- package/dist/create-server-workspace-store.d.ts +151 -0
- package/dist/create-server-workspace-store.d.ts.map +1 -0
- package/dist/create-server-workspace-store.js +199 -0
- package/dist/create-server-workspace-store.js.map +7 -0
- package/dist/create-workspace-store.d.ts +19773 -0
- package/dist/create-workspace-store.d.ts.map +1 -0
- package/dist/create-workspace-store.js +186 -0
- package/dist/create-workspace-store.js.map +7 -0
- package/dist/helpers/general.d.ts +88 -0
- package/dist/helpers/general.d.ts.map +1 -0
- package/dist/helpers/general.js +38 -0
- package/dist/helpers/general.js.map +7 -0
- package/dist/helpers/json-path-utils.d.ts +23 -0
- package/dist/helpers/json-path-utils.d.ts.map +1 -0
- package/dist/helpers/json-path-utils.js +16 -0
- package/dist/helpers/json-path-utils.js.map +7 -0
- package/dist/helpers/proxy.d.ts +63 -0
- package/dist/helpers/proxy.d.ts.map +1 -0
- package/dist/helpers/proxy.js +100 -0
- package/dist/helpers/proxy.js.map +7 -0
- package/dist/index.d.ts +4 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +13 -0
- package/dist/index.js.map +7 -0
- package/dist/schemas/callback.d.ts +1095 -0
- package/dist/schemas/callback.d.ts.map +1 -0
- package/dist/schemas/callback.js +11 -0
- package/dist/schemas/callback.js.map +7 -0
- package/dist/schemas/components.d.ts +2461 -0
- package/dist/schemas/components.d.ts.map +1 -0
- package/dist/schemas/components.js +38 -0
- package/dist/schemas/components.js.map +7 -0
- package/dist/schemas/contact.d.ts +10 -0
- package/dist/schemas/contact.d.ts.map +1 -0
- package/dist/schemas/contact.js +13 -0
- package/dist/schemas/contact.js.map +7 -0
- package/dist/schemas/discriminator.d.ts +12 -0
- package/dist/schemas/discriminator.d.ts.map +1 -0
- package/dist/schemas/discriminator.js +11 -0
- package/dist/schemas/discriminator.js.map +7 -0
- package/dist/schemas/encoding.d.ts +23 -0
- package/dist/schemas/encoding.d.ts.map +1 -0
- package/dist/schemas/encoding.js +13 -0
- package/dist/schemas/encoding.js.map +7 -0
- package/dist/schemas/example.d.ts +16 -0
- package/dist/schemas/example.d.ts.map +1 -0
- package/dist/schemas/example.js +15 -0
- package/dist/schemas/example.js.map +7 -0
- package/dist/schemas/external-documentation.d.ts +8 -0
- package/dist/schemas/external-documentation.d.ts.map +1 -0
- package/dist/schemas/external-documentation.js +11 -0
- package/dist/schemas/external-documentation.js.map +7 -0
- package/dist/schemas/header.d.ts +18 -0
- package/dist/schemas/header.d.ts.map +1 -0
- package/dist/schemas/header.js +13 -0
- package/dist/schemas/header.js.map +7 -0
- package/dist/schemas/info.d.ts +28 -0
- package/dist/schemas/info.d.ts.map +1 -0
- package/dist/schemas/info.js +23 -0
- package/dist/schemas/info.js.map +7 -0
- package/dist/schemas/license.d.ts +10 -0
- package/dist/schemas/license.d.ts.map +1 -0
- package/dist/schemas/license.js +13 -0
- package/dist/schemas/license.js.map +7 -0
- package/dist/schemas/link.d.ts +30 -0
- package/dist/schemas/link.d.ts.map +1 -0
- package/dist/schemas/link.js +20 -0
- package/dist/schemas/link.js.map +7 -0
- package/dist/schemas/media-type.d.ts +55 -0
- package/dist/schemas/media-type.d.ts.map +1 -0
- package/dist/schemas/media-type.js +19 -0
- package/dist/schemas/media-type.js.map +7 -0
- package/dist/schemas/oauth-flow.d.ts +12 -0
- package/dist/schemas/oauth-flow.d.ts.map +1 -0
- package/dist/schemas/oauth-flow.js +15 -0
- package/dist/schemas/oauth-flow.js.map +7 -0
- package/dist/schemas/oauthflows.d.ts +34 -0
- package/dist/schemas/oauthflows.d.ts.map +1 -0
- package/dist/schemas/oauthflows.js +16 -0
- package/dist/schemas/oauthflows.js.map +7 -0
- package/dist/schemas/openapi-document.d.ts +4683 -0
- package/dist/schemas/openapi-document.d.ts.map +1 -0
- package/dist/schemas/openapi-document.js +35 -0
- package/dist/schemas/openapi-document.js.map +7 -0
- package/dist/schemas/operation-without-callback.d.ts +190 -0
- package/dist/schemas/operation-without-callback.d.ts.map +1 -0
- package/dist/schemas/operation-without-callback.js +39 -0
- package/dist/schemas/operation-without-callback.js.map +7 -0
- package/dist/schemas/parameter.d.ts +25 -0
- package/dist/schemas/parameter.d.ts.map +1 -0
- package/dist/schemas/parameter.js +22 -0
- package/dist/schemas/parameter.js.map +7 -0
- package/dist/schemas/path-item.d.ts +1106 -0
- package/dist/schemas/path-item.d.ts.map +1 -0
- package/dist/schemas/path-item.js +37 -0
- package/dist/schemas/path-item.js.map +7 -0
- package/dist/schemas/paths.d.ts +1093 -0
- package/dist/schemas/paths.d.ts.map +1 -0
- package/dist/schemas/paths.js +11 -0
- package/dist/schemas/paths.js.map +7 -0
- package/dist/schemas/reference.d.ts +17 -0
- package/dist/schemas/reference.d.ts.map +1 -0
- package/dist/schemas/reference.js +15 -0
- package/dist/schemas/reference.js.map +7 -0
- package/dist/schemas/request-body.d.ts +54 -0
- package/dist/schemas/request-body.d.ts.map +1 -0
- package/dist/schemas/request-body.js +14 -0
- package/dist/schemas/request-body.js.map +7 -0
- package/dist/schemas/response.d.ts +84 -0
- package/dist/schemas/response.d.ts.map +1 -0
- package/dist/schemas/response.js +19 -0
- package/dist/schemas/response.js.map +7 -0
- package/dist/schemas/responses.d.ts +94 -0
- package/dist/schemas/responses.d.ts.map +1 -0
- package/dist/schemas/responses.js +8 -0
- package/dist/schemas/responses.js.map +7 -0
- package/dist/schemas/schema.d.ts +34 -0
- package/dist/schemas/schema.d.ts.map +1 -0
- package/dist/schemas/schema.js +22 -0
- package/dist/schemas/schema.js.map +7 -0
- package/dist/schemas/security-requirement.d.ts +11 -0
- package/dist/schemas/security-requirement.d.ts.map +1 -0
- package/dist/schemas/security-requirement.js +10 -0
- package/dist/schemas/security-requirement.js.map +7 -0
- package/dist/schemas/security-scheme.d.ts +137 -0
- package/dist/schemas/security-scheme.d.ts.map +1 -0
- package/dist/schemas/security-scheme.js +56 -0
- package/dist/schemas/security-scheme.js.map +7 -0
- package/dist/schemas/server-variable.d.ts +10 -0
- package/dist/schemas/server-variable.d.ts.map +1 -0
- package/dist/schemas/server-variable.js +13 -0
- package/dist/schemas/server-variable.js.map +7 -0
- package/dist/schemas/server-workspace.d.ts +14043 -0
- package/dist/schemas/server-workspace.d.ts.map +1 -0
- package/dist/schemas/server-workspace.js +29 -0
- package/dist/schemas/server-workspace.js.map +7 -0
- package/dist/schemas/server.d.ts +14 -0
- package/dist/schemas/server.d.ts.map +1 -0
- package/dist/schemas/server.js +14 -0
- package/dist/schemas/server.js.map +7 -0
- package/dist/schemas/tag.d.ts +13 -0
- package/dist/schemas/tag.d.ts.map +1 -0
- package/dist/schemas/tag.js +14 -0
- package/dist/schemas/tag.js.map +7 -0
- package/dist/schemas/xml.d.ts +18 -0
- package/dist/schemas/xml.d.ts.map +1 -0
- package/dist/schemas/xml.js +17 -0
- package/dist/schemas/xml.js.map +7 -0
- package/esbuild.ts +6 -0
- package/package.json +54 -0
- package/src/create-server-workspace-store.test.ts +429 -0
- package/src/create-server-workspace-store.ts +339 -0
- package/src/create-workspace-store.test.ts +488 -0
- package/src/create-workspace-store.ts +282 -0
- package/src/helpers/general.ts +115 -0
- package/src/helpers/json-path-utils.test.ts +13 -0
- package/src/helpers/json-path-utils.ts +38 -0
- package/src/helpers/proxy.test.ts +61 -0
- package/src/helpers/proxy.ts +213 -0
- package/src/index.ts +8 -0
- package/src/schemas/callback.ts +13 -0
- package/src/schemas/components.ts +36 -0
- package/src/schemas/contact.ts +11 -0
- package/src/schemas/discriminator.ts +13 -0
- package/src/schemas/encoding.ts +17 -0
- package/src/schemas/example.ts +17 -0
- package/src/schemas/external-documentation.ts +9 -0
- package/src/schemas/header.ts +19 -0
- package/src/schemas/info.ts +23 -0
- package/src/schemas/license.ts +11 -0
- package/src/schemas/link.ts +24 -0
- package/src/schemas/media-type.ts +21 -0
- package/src/schemas/oauth-flow.ts +13 -0
- package/src/schemas/oauthflows.ts +16 -0
- package/src/schemas/openapi-document.ts +34 -0
- package/src/schemas/operation-without-callback.ts +37 -0
- package/src/schemas/parameter.ts +26 -0
- package/src/schemas/path-item.ts +35 -0
- package/src/schemas/paths.ts +11 -0
- package/src/schemas/reference.ts +18 -0
- package/src/schemas/request-body.ts +12 -0
- package/src/schemas/response.ts +16 -0
- package/src/schemas/responses.ts +14 -0
- package/src/schemas/schema.ts +26 -0
- package/src/schemas/security-requirement.ts +16 -0
- package/src/schemas/security-scheme.ts +58 -0
- package/src/schemas/server-variable.ts +11 -0
- package/src/schemas/server-workspace.ts +36 -0
- package/src/schemas/server.ts +12 -0
- package/src/schemas/tag.ts +12 -0
- package/src/schemas/xml.ts +19 -0
- package/test/helpers.ts +16 -0
- package/tsconfig.build.json +12 -0
- package/tsconfig.json +8 -0
- package/vite.config.ts +9 -0
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"openapi-document.d.ts","sourceRoot":"","sources":["../../src/schemas/openapi-document.ts"],"names":[],"mappings":"AAAA,OAAO,EAAQ,KAAK,MAAM,EAAE,MAAM,mBAAmB,CAAA;AAUrD,eAAO,MAAM,qBAAqB;IAChC,uPAAuP;;IAEvP,kGAAkG;;;;;;;;;;;;;;;;;;IAElG,6IAA6I;;IAE7I,2NAA2N;;;;;;;;;;IAE3N,sDAAsD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAEtD,mfAAmf;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAEnf,sEAAsE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAEtE,kdAAkd;;IAEld,uWAAuW;;;;;;;;;IAEvW,yCAAyC;;;;;EAEzC,CAAA;AAEF,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC,OAAO,qBAAqB,CAAC,CAAA"}
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
import { Type } from "@sinclair/typebox";
|
|
2
|
+
import { InfoObject } from "./info.js";
|
|
3
|
+
import { ServerObject } from "./server.js";
|
|
4
|
+
import { PathsObject } from "./paths.js";
|
|
5
|
+
import { PathItemObject } from "./path-item.js";
|
|
6
|
+
import { ComponentsObject } from "./components.js";
|
|
7
|
+
import { SecurityRequirementObject } from "./security-requirement.js";
|
|
8
|
+
import { TagObject } from "./tag.js";
|
|
9
|
+
import { ExternalDocumentationObject } from "./external-documentation.js";
|
|
10
|
+
const OpenAPIDocumentSchema = Type.Object({
|
|
11
|
+
/** REQUIRED. This string MUST be the version number of the OpenAPI Specification that the OpenAPI Document uses. The openapi field SHOULD be used by tooling to interpret the OpenAPI Document. This is not related to the API info.version string. */
|
|
12
|
+
openapi: Type.String(),
|
|
13
|
+
/** REQUIRED. Provides metadata about the API. The metadata MAY be used by tooling as required. */
|
|
14
|
+
info: InfoObject,
|
|
15
|
+
/** The default value for the $schema keyword within Schema Objects contained within this OAS document. This MUST be in the form of a URI. */
|
|
16
|
+
jsonSchemaDialect: Type.Optional(Type.String()),
|
|
17
|
+
/** An array of Server Objects, which provide connectivity information to a target server. If the servers field is not provided, or is an empty array, the default value would be a Server Object with a url value of /. */
|
|
18
|
+
servers: Type.Optional(Type.Array(ServerObject)),
|
|
19
|
+
/** The available paths and operations for the API. */
|
|
20
|
+
paths: Type.Optional(PathsObject),
|
|
21
|
+
/** The incoming webhooks that MAY be received as part of this API and that the API consumer MAY choose to implement. Closely related to the callbacks feature, this section describes requests initiated other than by an API call, for example by an out of band registration. The key name is a unique string to refer to each webhook, while the (optionally referenced) Path Item Object describes a request that may be initiated by the API provider and the expected responses. An example is available. */
|
|
22
|
+
webhooks: Type.Optional(Type.Record(Type.String(), PathItemObject)),
|
|
23
|
+
/** An element to hold various Objects for the OpenAPI Description. */
|
|
24
|
+
components: Type.Optional(ComponentsObject),
|
|
25
|
+
/** A declaration of which security mechanisms can be used across the API. The list of values includes alternative Security Requirement Objects that can be used. Only one of the Security Requirement Objects need to be satisfied to authorize a request. Individual operations can override this definition. The list can be incomplete, up to being empty or absent. To make security explicitly optional, an empty security requirement ({}) can be included in the array. */
|
|
26
|
+
security: Type.Optional(Type.Array(SecurityRequirementObject)),
|
|
27
|
+
/** A list of tags used by the OpenAPI Description with additional metadata. The order of the tags can be used to reflect on their order by the parsing tools. Not all tags that are used by the Operation Object must be declared. The tags that are not declared MAY be organized randomly or based on the tools' logic. Each tag name in the list MUST be unique. */
|
|
28
|
+
tags: Type.Optional(Type.Array(TagObject)),
|
|
29
|
+
/** Additional external documentation. */
|
|
30
|
+
externalDocs: Type.Optional(ExternalDocumentationObject)
|
|
31
|
+
});
|
|
32
|
+
export {
|
|
33
|
+
OpenAPIDocumentSchema
|
|
34
|
+
};
|
|
35
|
+
//# sourceMappingURL=openapi-document.js.map
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
{
|
|
2
|
+
"version": 3,
|
|
3
|
+
"sources": ["../../src/schemas/openapi-document.ts"],
|
|
4
|
+
"sourcesContent": ["import { Type, type Static } from '@sinclair/typebox'\nimport { InfoObject } from './info'\nimport { ServerObject } from './server'\nimport { PathsObject } from './paths'\nimport { PathItemObject } from './path-item'\nimport { ComponentsObject } from './components'\nimport { SecurityRequirementObject } from './security-requirement'\nimport { TagObject } from './tag'\nimport { ExternalDocumentationObject } from './external-documentation'\n\nexport const OpenAPIDocumentSchema = Type.Object({\n /** REQUIRED. This string MUST be the version number of the OpenAPI Specification that the OpenAPI Document uses. The openapi field SHOULD be used by tooling to interpret the OpenAPI Document. This is not related to the API info.version string. */\n openapi: Type.String(),\n /** REQUIRED. Provides metadata about the API. The metadata MAY be used by tooling as required. */\n info: InfoObject,\n /** The default value for the $schema keyword within Schema Objects contained within this OAS document. This MUST be in the form of a URI. */\n jsonSchemaDialect: Type.Optional(Type.String()),\n /** An array of Server Objects, which provide connectivity information to a target server. If the servers field is not provided, or is an empty array, the default value would be a Server Object with a url value of /. */\n servers: Type.Optional(Type.Array(ServerObject)),\n /** The available paths and operations for the API. */\n paths: Type.Optional(PathsObject),\n /** The incoming webhooks that MAY be received as part of this API and that the API consumer MAY choose to implement. Closely related to the callbacks feature, this section describes requests initiated other than by an API call, for example by an out of band registration. The key name is a unique string to refer to each webhook, while the (optionally referenced) Path Item Object describes a request that may be initiated by the API provider and the expected responses. An example is available. */\n webhooks: Type.Optional(Type.Record(Type.String(), PathItemObject)),\n /** An element to hold various Objects for the OpenAPI Description. */\n components: Type.Optional(ComponentsObject),\n /** A declaration of which security mechanisms can be used across the API. The list of values includes alternative Security Requirement Objects that can be used. Only one of the Security Requirement Objects need to be satisfied to authorize a request. Individual operations can override this definition. The list can be incomplete, up to being empty or absent. To make security explicitly optional, an empty security requirement ({}) can be included in the array. */\n security: Type.Optional(Type.Array(SecurityRequirementObject)),\n /** A list of tags used by the OpenAPI Description with additional metadata. The order of the tags can be used to reflect on their order by the parsing tools. Not all tags that are used by the Operation Object must be declared. The tags that are not declared MAY be organized randomly or based on the tools' logic. Each tag name in the list MUST be unique. */\n tags: Type.Optional(Type.Array(TagObject)),\n /** Additional external documentation. */\n externalDocs: Type.Optional(ExternalDocumentationObject),\n})\n\nexport type OpenApiDocument = Static<typeof OpenAPIDocumentSchema>\n"],
|
|
5
|
+
"mappings": "AAAA,SAAS,YAAyB;AAClC,SAAS,kBAAkB;AAC3B,SAAS,oBAAoB;AAC7B,SAAS,mBAAmB;AAC5B,SAAS,sBAAsB;AAC/B,SAAS,wBAAwB;AACjC,SAAS,iCAAiC;AAC1C,SAAS,iBAAiB;AAC1B,SAAS,mCAAmC;AAErC,MAAM,wBAAwB,KAAK,OAAO;AAAA;AAAA,EAE/C,SAAS,KAAK,OAAO;AAAA;AAAA,EAErB,MAAM;AAAA;AAAA,EAEN,mBAAmB,KAAK,SAAS,KAAK,OAAO,CAAC;AAAA;AAAA,EAE9C,SAAS,KAAK,SAAS,KAAK,MAAM,YAAY,CAAC;AAAA;AAAA,EAE/C,OAAO,KAAK,SAAS,WAAW;AAAA;AAAA,EAEhC,UAAU,KAAK,SAAS,KAAK,OAAO,KAAK,OAAO,GAAG,cAAc,CAAC;AAAA;AAAA,EAElE,YAAY,KAAK,SAAS,gBAAgB;AAAA;AAAA,EAE1C,UAAU,KAAK,SAAS,KAAK,MAAM,yBAAyB,CAAC;AAAA;AAAA,EAE7D,MAAM,KAAK,SAAS,KAAK,MAAM,SAAS,CAAC;AAAA;AAAA,EAEzC,cAAc,KAAK,SAAS,2BAA2B;AACzD,CAAC;",
|
|
6
|
+
"names": []
|
|
7
|
+
}
|
|
@@ -0,0 +1,190 @@
|
|
|
1
|
+
/** Describes a single API operation on a path. */
|
|
2
|
+
export declare const OperationObjectWithoutCallback: import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TObject<{
|
|
3
|
+
/** A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier. */
|
|
4
|
+
tags: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TArray<import("@sinclair/typebox").TString>>;
|
|
5
|
+
/** A short summary of what the operation does. */
|
|
6
|
+
summary: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
|
|
7
|
+
/** A verbose explanation of the operation behavior. CommonMark syntax MAY be used for rich text representation. */
|
|
8
|
+
description: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
|
|
9
|
+
/** Additional external documentation for this operation. */
|
|
10
|
+
externalDocs: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TObject<{
|
|
11
|
+
description: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
|
|
12
|
+
url: import("@sinclair/typebox").TString;
|
|
13
|
+
}>>;
|
|
14
|
+
/** Unique string used to identify the operation. The id MUST be unique among all operations described in the API. The operationId value is case-sensitive. Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is RECOMMENDED to follow common programming naming conventions. */
|
|
15
|
+
operationId: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
|
|
16
|
+
/** A list of parameters that are applicable for this operation. If a parameter is already defined at the Path Item, the new definition will override it but can never remove it. The list MUST NOT include duplicated parameters. A unique parameter is defined by a combination of a name and location. The list can use the Reference Object to link to parameters that are defined in the OpenAPI Object's components.parameters. */
|
|
17
|
+
parameters: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TArray<import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TObject<{
|
|
18
|
+
name: import("@sinclair/typebox").TString;
|
|
19
|
+
in: import("@sinclair/typebox").TString;
|
|
20
|
+
description: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
|
|
21
|
+
required: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TBoolean>;
|
|
22
|
+
deprecated: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TBoolean>;
|
|
23
|
+
allowEmptyValue: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TBoolean>;
|
|
24
|
+
}>, import("@sinclair/typebox").TObject<{
|
|
25
|
+
$ref: import("@sinclair/typebox").TString;
|
|
26
|
+
$status: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TLiteral<"loading">, import("@sinclair/typebox").TLiteral<"error">]>>;
|
|
27
|
+
summary: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
|
|
28
|
+
description: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
|
|
29
|
+
}>]>>>;
|
|
30
|
+
/** The request body applicable for this operation. The requestBody is fully supported in HTTP methods where the HTTP 1.1 specification RFC7231 has explicitly defined semantics for request bodies. In other cases where the HTTP spec is vague (such as GET, HEAD and DELETE), requestBody is permitted but does not have well-defined semantics and SHOULD be avoided if possible. */
|
|
31
|
+
requestBody: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TObject<{
|
|
32
|
+
description: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
|
|
33
|
+
content: import("@sinclair/typebox").TRecord<import("@sinclair/typebox").TString, import("@sinclair/typebox").TObject<{
|
|
34
|
+
schema: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TObject<{
|
|
35
|
+
discriminator: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TObject<{
|
|
36
|
+
propertyName: import("@sinclair/typebox").TString;
|
|
37
|
+
mapping: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TRecord<import("@sinclair/typebox").TString, import("@sinclair/typebox").TString>>;
|
|
38
|
+
}>>;
|
|
39
|
+
xml: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TObject<{
|
|
40
|
+
name: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
|
|
41
|
+
namespace: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
|
|
42
|
+
prefix: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
|
|
43
|
+
attribute: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TBoolean>;
|
|
44
|
+
wrapped: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TBoolean>;
|
|
45
|
+
}>>;
|
|
46
|
+
externalDocs: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TObject<{
|
|
47
|
+
description: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
|
|
48
|
+
url: import("@sinclair/typebox").TString;
|
|
49
|
+
}>>;
|
|
50
|
+
example: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TAny>;
|
|
51
|
+
}>>;
|
|
52
|
+
example: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TAny>;
|
|
53
|
+
examples: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TRecord<import("@sinclair/typebox").TString, import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TObject<{
|
|
54
|
+
summary: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
|
|
55
|
+
description: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
|
|
56
|
+
value: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TAny>;
|
|
57
|
+
externalValue: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
|
|
58
|
+
}>, import("@sinclair/typebox").TObject<{
|
|
59
|
+
$ref: import("@sinclair/typebox").TString;
|
|
60
|
+
$status: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TLiteral<"loading">, import("@sinclair/typebox").TLiteral<"error">]>>;
|
|
61
|
+
summary: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
|
|
62
|
+
description: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
|
|
63
|
+
}>]>>>;
|
|
64
|
+
encoding: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TRecord<import("@sinclair/typebox").TString, import("@sinclair/typebox").TObject<{
|
|
65
|
+
contentType: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
|
|
66
|
+
headers: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TRecord<import("@sinclair/typebox").TString, import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TObject<{
|
|
67
|
+
description: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
|
|
68
|
+
required: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TBoolean>;
|
|
69
|
+
deprecated: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TBoolean>;
|
|
70
|
+
}>, import("@sinclair/typebox").TObject<{
|
|
71
|
+
$ref: import("@sinclair/typebox").TString;
|
|
72
|
+
$status: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TLiteral<"loading">, import("@sinclair/typebox").TLiteral<"error">]>>;
|
|
73
|
+
summary: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
|
|
74
|
+
description: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
|
|
75
|
+
}>]>>>;
|
|
76
|
+
}>>>;
|
|
77
|
+
}>>;
|
|
78
|
+
required: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TBoolean>;
|
|
79
|
+
}>, import("@sinclair/typebox").TObject<{
|
|
80
|
+
$ref: import("@sinclair/typebox").TString;
|
|
81
|
+
$status: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TLiteral<"loading">, import("@sinclair/typebox").TLiteral<"error">]>>;
|
|
82
|
+
summary: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
|
|
83
|
+
description: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
|
|
84
|
+
}>]>>;
|
|
85
|
+
/** The list of possible responses as they are returned from executing this operation. */
|
|
86
|
+
responses: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TRecord<import("@sinclair/typebox").TString, import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TObject<{
|
|
87
|
+
description: import("@sinclair/typebox").TString;
|
|
88
|
+
headers: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TRecord<import("@sinclair/typebox").TString, import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TObject<{
|
|
89
|
+
description: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
|
|
90
|
+
required: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TBoolean>;
|
|
91
|
+
deprecated: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TBoolean>;
|
|
92
|
+
}>, import("@sinclair/typebox").TObject<{
|
|
93
|
+
$ref: import("@sinclair/typebox").TString;
|
|
94
|
+
$status: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TLiteral<"loading">, import("@sinclair/typebox").TLiteral<"error">]>>;
|
|
95
|
+
summary: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
|
|
96
|
+
description: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
|
|
97
|
+
}>]>>>;
|
|
98
|
+
content: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TRecord<import("@sinclair/typebox").TString, import("@sinclair/typebox").TObject<{
|
|
99
|
+
schema: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TObject<{
|
|
100
|
+
discriminator: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TObject<{
|
|
101
|
+
propertyName: import("@sinclair/typebox").TString;
|
|
102
|
+
mapping: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TRecord<import("@sinclair/typebox").TString, import("@sinclair/typebox").TString>>;
|
|
103
|
+
}>>;
|
|
104
|
+
xml: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TObject<{
|
|
105
|
+
name: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
|
|
106
|
+
namespace: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
|
|
107
|
+
prefix: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
|
|
108
|
+
attribute: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TBoolean>;
|
|
109
|
+
wrapped: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TBoolean>;
|
|
110
|
+
}>>;
|
|
111
|
+
externalDocs: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TObject<{
|
|
112
|
+
description: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
|
|
113
|
+
url: import("@sinclair/typebox").TString;
|
|
114
|
+
}>>;
|
|
115
|
+
example: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TAny>;
|
|
116
|
+
}>>;
|
|
117
|
+
example: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TAny>;
|
|
118
|
+
examples: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TRecord<import("@sinclair/typebox").TString, import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TObject<{
|
|
119
|
+
summary: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
|
|
120
|
+
description: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
|
|
121
|
+
value: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TAny>;
|
|
122
|
+
externalValue: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
|
|
123
|
+
}>, import("@sinclair/typebox").TObject<{
|
|
124
|
+
$ref: import("@sinclair/typebox").TString;
|
|
125
|
+
$status: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TLiteral<"loading">, import("@sinclair/typebox").TLiteral<"error">]>>;
|
|
126
|
+
summary: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
|
|
127
|
+
description: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
|
|
128
|
+
}>]>>>;
|
|
129
|
+
encoding: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TRecord<import("@sinclair/typebox").TString, import("@sinclair/typebox").TObject<{
|
|
130
|
+
contentType: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
|
|
131
|
+
headers: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TRecord<import("@sinclair/typebox").TString, import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TObject<{
|
|
132
|
+
description: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
|
|
133
|
+
required: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TBoolean>;
|
|
134
|
+
deprecated: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TBoolean>;
|
|
135
|
+
}>, import("@sinclair/typebox").TObject<{
|
|
136
|
+
$ref: import("@sinclair/typebox").TString;
|
|
137
|
+
$status: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TLiteral<"loading">, import("@sinclair/typebox").TLiteral<"error">]>>;
|
|
138
|
+
summary: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
|
|
139
|
+
description: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
|
|
140
|
+
}>]>>>;
|
|
141
|
+
}>>>;
|
|
142
|
+
}>>>;
|
|
143
|
+
links: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TRecord<import("@sinclair/typebox").TString, import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TObject<{
|
|
144
|
+
operationRef: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
|
|
145
|
+
operationId: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
|
|
146
|
+
parameters: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TRecord<import("@sinclair/typebox").TString, import("@sinclair/typebox").TAny>>;
|
|
147
|
+
requestBody: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TAny>;
|
|
148
|
+
description: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
|
|
149
|
+
server: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TObject<{
|
|
150
|
+
url: import("@sinclair/typebox").TString;
|
|
151
|
+
description: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
|
|
152
|
+
variables: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TRecord<import("@sinclair/typebox").TString, import("@sinclair/typebox").TObject<{
|
|
153
|
+
enum: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TArray<import("@sinclair/typebox").TString>>;
|
|
154
|
+
default: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
|
|
155
|
+
description: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
|
|
156
|
+
}>>>;
|
|
157
|
+
}>>;
|
|
158
|
+
}>, import("@sinclair/typebox").TObject<{
|
|
159
|
+
$ref: import("@sinclair/typebox").TString;
|
|
160
|
+
$status: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TLiteral<"loading">, import("@sinclair/typebox").TLiteral<"error">]>>;
|
|
161
|
+
summary: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
|
|
162
|
+
description: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
|
|
163
|
+
}>]>>>;
|
|
164
|
+
}>, import("@sinclair/typebox").TObject<{
|
|
165
|
+
$ref: import("@sinclair/typebox").TString;
|
|
166
|
+
$status: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TLiteral<"loading">, import("@sinclair/typebox").TLiteral<"error">]>>;
|
|
167
|
+
summary: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
|
|
168
|
+
description: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
|
|
169
|
+
}>]>>>;
|
|
170
|
+
/** Declares this operation to be deprecated. Consumers SHOULD refrain from usage of the declared operation. Default value is false. */
|
|
171
|
+
deprecated: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TBoolean>;
|
|
172
|
+
/** A declaration of which security mechanisms can be used for this operation. The list of values includes alternative Security Requirement Objects that can be used. Only one of the Security Requirement Objects need to be satisfied to authorize a request. To make security optional, an empty security requirement ({}) can be included in the array. This definition overrides any declared top-level security. To remove a top-level security declaration, an empty array can be used. */
|
|
173
|
+
security: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TArray<import("@sinclair/typebox").TRecord<import("@sinclair/typebox").TString, import("@sinclair/typebox").TArray<import("@sinclair/typebox").TString>>>>;
|
|
174
|
+
/** An alternative servers array to service this operation. If a servers array is specified at the Path Item Object or OpenAPI Object level, it will be overridden by this value. */
|
|
175
|
+
servers: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TArray<import("@sinclair/typebox").TObject<{
|
|
176
|
+
url: import("@sinclair/typebox").TString;
|
|
177
|
+
description: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
|
|
178
|
+
variables: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TRecord<import("@sinclair/typebox").TString, import("@sinclair/typebox").TObject<{
|
|
179
|
+
enum: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TArray<import("@sinclair/typebox").TString>>;
|
|
180
|
+
default: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
|
|
181
|
+
description: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
|
|
182
|
+
}>>>;
|
|
183
|
+
}>>>;
|
|
184
|
+
}>, import("@sinclair/typebox").TObject<{
|
|
185
|
+
$ref: import("@sinclair/typebox").TString;
|
|
186
|
+
$status: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TLiteral<"loading">, import("@sinclair/typebox").TLiteral<"error">]>>;
|
|
187
|
+
summary: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
|
|
188
|
+
description: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
|
|
189
|
+
}>]>;
|
|
190
|
+
//# sourceMappingURL=operation-without-callback.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"operation-without-callback.d.ts","sourceRoot":"","sources":["../../src/schemas/operation-without-callback.ts"],"names":[],"mappings":"AASA,kDAAkD;AAClD,eAAO,MAAM,8BAA8B;IAEvC,6IAA6I;;IAE7I,kDAAkD;;IAElD,mHAAmH;;IAEnH,4DAA4D;;;;;IAE5D,2TAA2T;;IAE3T,waAAwa;;;;;;;;;;;;;;IAExa,wXAAwX;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAExX,yFAAyF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAEzF,uIAAuI;;IAEvI,ieAAie;;IAEje,oLAAoL;;;;;;;;;;;;;;;IAItL,CAAA"}
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
import { Type } from "@sinclair/typebox";
|
|
2
|
+
import { ExternalDocumentationObject } from "./external-documentation.js";
|
|
3
|
+
import { ParameterObject } from "./parameter.js";
|
|
4
|
+
import { ReferenceObject } from "./reference.js";
|
|
5
|
+
import { RequestBodyObject } from "./request-body.js";
|
|
6
|
+
import { ResponsesObject } from "./responses.js";
|
|
7
|
+
import { SecurityRequirementObject } from "./security-requirement.js";
|
|
8
|
+
import { ServerObject } from "./server.js";
|
|
9
|
+
const OperationObjectWithoutCallback = Type.Union([
|
|
10
|
+
Type.Object({
|
|
11
|
+
/** A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier. */
|
|
12
|
+
tags: Type.Optional(Type.Array(Type.String())),
|
|
13
|
+
/** A short summary of what the operation does. */
|
|
14
|
+
summary: Type.Optional(Type.String()),
|
|
15
|
+
/** A verbose explanation of the operation behavior. CommonMark syntax MAY be used for rich text representation. */
|
|
16
|
+
description: Type.Optional(Type.String()),
|
|
17
|
+
/** Additional external documentation for this operation. */
|
|
18
|
+
externalDocs: Type.Optional(ExternalDocumentationObject),
|
|
19
|
+
/** Unique string used to identify the operation. The id MUST be unique among all operations described in the API. The operationId value is case-sensitive. Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is RECOMMENDED to follow common programming naming conventions. */
|
|
20
|
+
operationId: Type.Optional(Type.String()),
|
|
21
|
+
/** A list of parameters that are applicable for this operation. If a parameter is already defined at the Path Item, the new definition will override it but can never remove it. The list MUST NOT include duplicated parameters. A unique parameter is defined by a combination of a name and location. The list can use the Reference Object to link to parameters that are defined in the OpenAPI Object's components.parameters. */
|
|
22
|
+
parameters: Type.Optional(Type.Array(Type.Union([ParameterObject, ReferenceObject]))),
|
|
23
|
+
/** The request body applicable for this operation. The requestBody is fully supported in HTTP methods where the HTTP 1.1 specification RFC7231 has explicitly defined semantics for request bodies. In other cases where the HTTP spec is vague (such as GET, HEAD and DELETE), requestBody is permitted but does not have well-defined semantics and SHOULD be avoided if possible. */
|
|
24
|
+
requestBody: Type.Optional(Type.Union([RequestBodyObject, ReferenceObject])),
|
|
25
|
+
/** The list of possible responses as they are returned from executing this operation. */
|
|
26
|
+
responses: Type.Optional(ResponsesObject),
|
|
27
|
+
/** Declares this operation to be deprecated. Consumers SHOULD refrain from usage of the declared operation. Default value is false. */
|
|
28
|
+
deprecated: Type.Optional(Type.Boolean()),
|
|
29
|
+
/** A declaration of which security mechanisms can be used for this operation. The list of values includes alternative Security Requirement Objects that can be used. Only one of the Security Requirement Objects need to be satisfied to authorize a request. To make security optional, an empty security requirement ({}) can be included in the array. This definition overrides any declared top-level security. To remove a top-level security declaration, an empty array can be used. */
|
|
30
|
+
security: Type.Optional(Type.Array(SecurityRequirementObject)),
|
|
31
|
+
/** An alternative servers array to service this operation. If a servers array is specified at the Path Item Object or OpenAPI Object level, it will be overridden by this value. */
|
|
32
|
+
servers: Type.Optional(Type.Array(ServerObject))
|
|
33
|
+
}),
|
|
34
|
+
ReferenceObject
|
|
35
|
+
]);
|
|
36
|
+
export {
|
|
37
|
+
OperationObjectWithoutCallback
|
|
38
|
+
};
|
|
39
|
+
//# sourceMappingURL=operation-without-callback.js.map
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
{
|
|
2
|
+
"version": 3,
|
|
3
|
+
"sources": ["../../src/schemas/operation-without-callback.ts"],
|
|
4
|
+
"sourcesContent": ["import { Type } from '@sinclair/typebox'\nimport { ExternalDocumentationObject } from './external-documentation'\nimport { ParameterObject } from './parameter'\nimport { ReferenceObject } from './reference'\nimport { RequestBodyObject } from './request-body'\nimport { ResponsesObject } from './responses'\nimport { SecurityRequirementObject } from './security-requirement'\nimport { ServerObject } from './server'\n\n/** Describes a single API operation on a path. */\nexport const OperationObjectWithoutCallback = Type.Union([\n Type.Object({\n /** A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier. */\n tags: Type.Optional(Type.Array(Type.String())),\n /** A short summary of what the operation does. */\n summary: Type.Optional(Type.String()),\n /** A verbose explanation of the operation behavior. CommonMark syntax MAY be used for rich text representation. */\n description: Type.Optional(Type.String()),\n /** Additional external documentation for this operation. */\n externalDocs: Type.Optional(ExternalDocumentationObject),\n /** Unique string used to identify the operation. The id MUST be unique among all operations described in the API. The operationId value is case-sensitive. Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is RECOMMENDED to follow common programming naming conventions. */\n operationId: Type.Optional(Type.String()),\n /** A list of parameters that are applicable for this operation. If a parameter is already defined at the Path Item, the new definition will override it but can never remove it. The list MUST NOT include duplicated parameters. A unique parameter is defined by a combination of a name and location. The list can use the Reference Object to link to parameters that are defined in the OpenAPI Object's components.parameters. */\n parameters: Type.Optional(Type.Array(Type.Union([ParameterObject, ReferenceObject]))),\n /** The request body applicable for this operation. The requestBody is fully supported in HTTP methods where the HTTP 1.1 specification RFC7231 has explicitly defined semantics for request bodies. In other cases where the HTTP spec is vague (such as GET, HEAD and DELETE), requestBody is permitted but does not have well-defined semantics and SHOULD be avoided if possible. */\n requestBody: Type.Optional(Type.Union([RequestBodyObject, ReferenceObject])),\n /** The list of possible responses as they are returned from executing this operation. */\n responses: Type.Optional(ResponsesObject),\n /** Declares this operation to be deprecated. Consumers SHOULD refrain from usage of the declared operation. Default value is false. */\n deprecated: Type.Optional(Type.Boolean()),\n /** A declaration of which security mechanisms can be used for this operation. The list of values includes alternative Security Requirement Objects that can be used. Only one of the Security Requirement Objects need to be satisfied to authorize a request. To make security optional, an empty security requirement ({}) can be included in the array. This definition overrides any declared top-level security. To remove a top-level security declaration, an empty array can be used. */\n security: Type.Optional(Type.Array(SecurityRequirementObject)),\n /** An alternative servers array to service this operation. If a servers array is specified at the Path Item Object or OpenAPI Object level, it will be overridden by this value. */\n servers: Type.Optional(Type.Array(ServerObject)),\n }),\n ReferenceObject,\n])\n"],
|
|
5
|
+
"mappings": "AAAA,SAAS,YAAY;AACrB,SAAS,mCAAmC;AAC5C,SAAS,uBAAuB;AAChC,SAAS,uBAAuB;AAChC,SAAS,yBAAyB;AAClC,SAAS,uBAAuB;AAChC,SAAS,iCAAiC;AAC1C,SAAS,oBAAoB;AAGtB,MAAM,iCAAiC,KAAK,MAAM;AAAA,EACvD,KAAK,OAAO;AAAA;AAAA,IAEV,MAAM,KAAK,SAAS,KAAK,MAAM,KAAK,OAAO,CAAC,CAAC;AAAA;AAAA,IAE7C,SAAS,KAAK,SAAS,KAAK,OAAO,CAAC;AAAA;AAAA,IAEpC,aAAa,KAAK,SAAS,KAAK,OAAO,CAAC;AAAA;AAAA,IAExC,cAAc,KAAK,SAAS,2BAA2B;AAAA;AAAA,IAEvD,aAAa,KAAK,SAAS,KAAK,OAAO,CAAC;AAAA;AAAA,IAExC,YAAY,KAAK,SAAS,KAAK,MAAM,KAAK,MAAM,CAAC,iBAAiB,eAAe,CAAC,CAAC,CAAC;AAAA;AAAA,IAEpF,aAAa,KAAK,SAAS,KAAK,MAAM,CAAC,mBAAmB,eAAe,CAAC,CAAC;AAAA;AAAA,IAE3E,WAAW,KAAK,SAAS,eAAe;AAAA;AAAA,IAExC,YAAY,KAAK,SAAS,KAAK,QAAQ,CAAC;AAAA;AAAA,IAExC,UAAU,KAAK,SAAS,KAAK,MAAM,yBAAyB,CAAC;AAAA;AAAA,IAE7D,SAAS,KAAK,SAAS,KAAK,MAAM,YAAY,CAAC;AAAA,EACjD,CAAC;AAAA,EACD;AACF,CAAC;",
|
|
6
|
+
"names": []
|
|
7
|
+
}
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Describes a single operation parameter.
|
|
3
|
+
*
|
|
4
|
+
* A unique parameter is defined by a combination of a name and location.
|
|
5
|
+
*
|
|
6
|
+
* See Appendix E for a detailed examination of percent-encoding concerns, including interactions with the application/x-www-form-urlencoded query string format.
|
|
7
|
+
*/
|
|
8
|
+
export declare const ParameterObject: import("@sinclair/typebox").TObject<{
|
|
9
|
+
/** REQUIRED. The name of the parameter. Parameter names are case sensitive.
|
|
10
|
+
* - If in is "path", the name field MUST correspond to a template expression occurring within the path field in the Paths Object. See Path Templating for further information.
|
|
11
|
+
* - If in is "header" and the name field is "Accept", "Content-Type" or "Authorization", the parameter definition SHALL be ignored.
|
|
12
|
+
* - For all other cases, the name corresponds to the parameter name used by the in field. */
|
|
13
|
+
name: import("@sinclair/typebox").TString;
|
|
14
|
+
/** REQUIRED. The location of the parameter. Possible values are "query", "header", "path" or "cookie". */
|
|
15
|
+
in: import("@sinclair/typebox").TString;
|
|
16
|
+
/** A brief description of the parameter. This could contain examples of use. CommonMark syntax MAY be used for rich text representation. */
|
|
17
|
+
description: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
|
|
18
|
+
/** Determines whether this parameter is mandatory. If the parameter location is "path", this field is REQUIRED and its value MUST be true. Otherwise, the field MAY be included and its default value is false. */
|
|
19
|
+
required: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TBoolean>;
|
|
20
|
+
/** Specifies that a parameter is deprecated and SHOULD be transitioned out of usage. Default value is false. */
|
|
21
|
+
deprecated: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TBoolean>;
|
|
22
|
+
/** If true, clients MAY pass a zero-length string value in place of parameters that would otherwise be omitted entirely, which the server SHOULD interpret as the parameter being unused. Default value is false. If style is used, and if behavior is n/a (cannot be serialized), the value of allowEmptyValue SHALL be ignored. Interactions between this field and the parameter's Schema Object are implementation-defined. This field is valid only for query parameters. Use of this field is NOT RECOMMENDED, and it is likely to be removed in a later revision. */
|
|
23
|
+
allowEmptyValue: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TBoolean>;
|
|
24
|
+
}>;
|
|
25
|
+
//# sourceMappingURL=parameter.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"parameter.d.ts","sourceRoot":"","sources":["../../src/schemas/parameter.ts"],"names":[],"mappings":"AAEA;;;;;;GAMG;AACH,eAAO,MAAM,eAAe;IAC1B;;;oGAGgG;;IAEhG,0GAA0G;;IAE1G,4IAA4I;;IAE5I,mNAAmN;;IAEnN,gHAAgH;;IAEhH,4iBAA4iB;;EAE5iB,CAAA"}
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
import { Type } from "@sinclair/typebox";
|
|
2
|
+
const ParameterObject = Type.Object({
|
|
3
|
+
/** REQUIRED. The name of the parameter. Parameter names are case sensitive.
|
|
4
|
+
* - If in is "path", the name field MUST correspond to a template expression occurring within the path field in the Paths Object. See Path Templating for further information.
|
|
5
|
+
* - If in is "header" and the name field is "Accept", "Content-Type" or "Authorization", the parameter definition SHALL be ignored.
|
|
6
|
+
* - For all other cases, the name corresponds to the parameter name used by the in field. */
|
|
7
|
+
name: Type.String(),
|
|
8
|
+
/** REQUIRED. The location of the parameter. Possible values are "query", "header", "path" or "cookie". */
|
|
9
|
+
in: Type.String(),
|
|
10
|
+
/** A brief description of the parameter. This could contain examples of use. CommonMark syntax MAY be used for rich text representation. */
|
|
11
|
+
description: Type.Optional(Type.String()),
|
|
12
|
+
/** Determines whether this parameter is mandatory. If the parameter location is "path", this field is REQUIRED and its value MUST be true. Otherwise, the field MAY be included and its default value is false. */
|
|
13
|
+
required: Type.Optional(Type.Boolean()),
|
|
14
|
+
/** Specifies that a parameter is deprecated and SHOULD be transitioned out of usage. Default value is false. */
|
|
15
|
+
deprecated: Type.Optional(Type.Boolean()),
|
|
16
|
+
/** If true, clients MAY pass a zero-length string value in place of parameters that would otherwise be omitted entirely, which the server SHOULD interpret as the parameter being unused. Default value is false. If style is used, and if behavior is n/a (cannot be serialized), the value of allowEmptyValue SHALL be ignored. Interactions between this field and the parameter's Schema Object are implementation-defined. This field is valid only for query parameters. Use of this field is NOT RECOMMENDED, and it is likely to be removed in a later revision. */
|
|
17
|
+
allowEmptyValue: Type.Optional(Type.Boolean())
|
|
18
|
+
});
|
|
19
|
+
export {
|
|
20
|
+
ParameterObject
|
|
21
|
+
};
|
|
22
|
+
//# sourceMappingURL=parameter.js.map
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
{
|
|
2
|
+
"version": 3,
|
|
3
|
+
"sources": ["../../src/schemas/parameter.ts"],
|
|
4
|
+
"sourcesContent": ["import { Type } from '@sinclair/typebox'\n\n/**\n * Describes a single operation parameter.\n *\n * A unique parameter is defined by a combination of a name and location.\n *\n * See Appendix E for a detailed examination of percent-encoding concerns, including interactions with the application/x-www-form-urlencoded query string format.\n */\nexport const ParameterObject = Type.Object({\n /** REQUIRED. The name of the parameter. Parameter names are case sensitive.\n * - If in is \"path\", the name field MUST correspond to a template expression occurring within the path field in the Paths Object. See Path Templating for further information.\n * - If in is \"header\" and the name field is \"Accept\", \"Content-Type\" or \"Authorization\", the parameter definition SHALL be ignored.\n * - For all other cases, the name corresponds to the parameter name used by the in field. */\n name: Type.String(),\n /** REQUIRED. The location of the parameter. Possible values are \"query\", \"header\", \"path\" or \"cookie\". */\n in: Type.String(),\n /** A brief description of the parameter. This could contain examples of use. CommonMark syntax MAY be used for rich text representation. */\n description: Type.Optional(Type.String()),\n /** Determines whether this parameter is mandatory. If the parameter location is \"path\", this field is REQUIRED and its value MUST be true. Otherwise, the field MAY be included and its default value is false. */\n required: Type.Optional(Type.Boolean()),\n /** Specifies that a parameter is deprecated and SHOULD be transitioned out of usage. Default value is false. */\n deprecated: Type.Optional(Type.Boolean()),\n /** If true, clients MAY pass a zero-length string value in place of parameters that would otherwise be omitted entirely, which the server SHOULD interpret as the parameter being unused. Default value is false. If style is used, and if behavior is n/a (cannot be serialized), the value of allowEmptyValue SHALL be ignored. Interactions between this field and the parameter's Schema Object are implementation-defined. This field is valid only for query parameters. Use of this field is NOT RECOMMENDED, and it is likely to be removed in a later revision. */\n allowEmptyValue: Type.Optional(Type.Boolean()),\n})\n"],
|
|
5
|
+
"mappings": "AAAA,SAAS,YAAY;AASd,MAAM,kBAAkB,KAAK,OAAO;AAAA;AAAA;AAAA;AAAA;AAAA,EAKzC,MAAM,KAAK,OAAO;AAAA;AAAA,EAElB,IAAI,KAAK,OAAO;AAAA;AAAA,EAEhB,aAAa,KAAK,SAAS,KAAK,OAAO,CAAC;AAAA;AAAA,EAExC,UAAU,KAAK,SAAS,KAAK,QAAQ,CAAC;AAAA;AAAA,EAEtC,YAAY,KAAK,SAAS,KAAK,QAAQ,CAAC;AAAA;AAAA,EAExC,iBAAiB,KAAK,SAAS,KAAK,QAAQ,CAAC;AAC/C,CAAC;",
|
|
6
|
+
"names": []
|
|
7
|
+
}
|