@twin.org/tools-models 0.0.3-next.16

package/docs/reference/interfaces/IOpenApi.md

@@ -0,0 +1,147 @@
+# Interface: IOpenApi
+
+The OpenAPI document definition.
+
+## See
+
+https://spec.openapis.org/oas/latest.html#openapi-object
+
+## Properties
+
+### openapi {#openapi}
+
+> **openapi**: `string`
+
+The OpenAPI specification version.
+
+#### See
+
+https://spec.openapis.org/oas/latest.html#fixed-fields
+
+***
+
+### $self? {#self}
+
+> `optional` **$self?**: `string`
+
+The self-assigned URI of the document.
+
+#### See
+
+https://spec.openapis.org/oas/latest.html#fixed-fields
+
+***
+
+### info {#info}
+
+> **info**: [`IOpenApiInfo`](IOpenApiInfo.md)
+
+The metadata for the API.
+
+#### See
+
+https://spec.openapis.org/oas/latest.html#fixed-fields
+
+***
+
+### jsonSchemaDialect? {#jsonschemadialect}
+
+> `optional` **jsonSchemaDialect?**: `string`
+
+The default JSON Schema dialect URI.
+
+#### See
+
+https://spec.openapis.org/oas/latest.html#fixed-fields
+
+***
+
+### servers? {#servers}
+
+> `optional` **servers?**: [`IOpenApiServer`](IOpenApiServer.md)[]
+
+Connectivity information for target servers.
+
+#### See
+
+https://spec.openapis.org/oas/latest.html#fixed-fields
+
+***
+
+### paths? {#paths}
+
+> `optional` **paths?**: `object`
+
+Available paths and operations.
+
+#### Index Signature
+
+\[`path`: `string`\]: [`IOpenApiPathItem`](IOpenApiPathItem.md)
+
+#### See
+
+https://spec.openapis.org/oas/latest.html#fixed-fields
+
+***
+
+### webhooks? {#webhooks}
+
+> `optional` **webhooks?**: `object`
+
+Incoming webhooks keyed by name.
+
+#### Index Signature
+
+\[`name`: `string`\]: [`IOpenApiPathItem`](IOpenApiPathItem.md)
+
+#### See
+
+https://spec.openapis.org/oas/latest.html#fixed-fields
+
+***
+
+### components? {#components}
+
+> `optional` **components?**: [`IOpenApiComponents`](IOpenApiComponents.md)
+
+Reusable components.
+
+#### See
+
+https://spec.openapis.org/oas/latest.html#fixed-fields
+
+***
+
+### security? {#security}
+
+> `optional` **security?**: [`IOpenApiSecurityRequirement`](IOpenApiSecurityRequirement.md)[]
+
+API-wide security requirements.
+
+#### See
+
+https://spec.openapis.org/oas/latest.html#fixed-fields
+
+***
+
+### tags? {#tags}
+
+> `optional` **tags?**: [`IOpenApiTag`](IOpenApiTag.md)[]
+
+Tags used by the API description.
+
+#### See
+
+https://spec.openapis.org/oas/latest.html#fixed-fields
+
+***
+
+### externalDocs? {#externaldocs}
+
+> `optional` **externalDocs?**: [`IOpenApiExternalDocumentation`](IOpenApiExternalDocumentation.md)
+
+Additional external documentation.
+
+#### See
+
+https://spec.openapis.org/oas/latest.html#fixed-fields

package/docs/reference/interfaces/IOpenApiComponents.md

@@ -0,0 +1,115 @@
+# Interface: IOpenApiComponents
+
+An OpenAPI Components Object.
+
+## See
+
+https://spec.openapis.org/oas/latest.html#components-object
+
+## Properties
+
+### schemas? {#schemas}
+
+> `optional` **schemas?**: `object`
+
+Reusable schemas.
+
+#### Index Signature
+
+\[`name`: `string`\]: `boolean` \| [`IJsonSchema`](IJsonSchema.md)
+
+***
+
+### responses? {#responses}
+
+> `optional` **responses?**: `object`
+
+Reusable responses.
+
+#### Index Signature
+
+\[`name`: `string`\]: [`IOpenApiReference`](IOpenApiReference.md) \| [`IOpenApiResponse`](IOpenApiResponse.md)
+
+***
+
+### parameters? {#parameters}
+
+> `optional` **parameters?**: `object`
+
+Reusable parameters.
+
+#### Index Signature
+
+\[`name`: `string`\]: [`IOpenApiReference`](IOpenApiReference.md) \| [`IOpenApiParameter`](IOpenApiParameter.md)
+
+***
+
+### examples? {#examples}
+
+> `optional` **examples?**: `object`
+
+Reusable examples.
+
+#### Index Signature
+
+\[`name`: `string`\]: [`IOpenApiExample`](IOpenApiExample.md) \| [`IOpenApiReference`](IOpenApiReference.md)
+
+***
+
+### requestBodies? {#requestbodies}
+
+> `optional` **requestBodies?**: `object`
+
+Reusable request bodies.
+
+#### Index Signature
+
+\[`name`: `string`\]: [`IOpenApiReference`](IOpenApiReference.md) \| [`IOpenApiRequestBody`](IOpenApiRequestBody.md)
+
+***
+
+### headers? {#headers}
+
+> `optional` **headers?**: `object`
+
+Reusable headers.
+
+#### Index Signature
+
+\[`name`: `string`\]: [`IOpenApiReference`](IOpenApiReference.md) \| [`IOpenApiHeader`](IOpenApiHeader.md)
+
+***
+
+### securitySchemes? {#securityschemes}
+
+> `optional` **securitySchemes?**: `object`
+
+Reusable security schemes.
+
+#### Index Signature
+
+\[`name`: `string`\]: [`IOpenApiReference`](IOpenApiReference.md) \| [`IOpenApiSecurityScheme`](../type-aliases/IOpenApiSecurityScheme.md)
+
+***
+
+### pathItems? {#pathitems}
+
+> `optional` **pathItems?**: `object`
+
+Reusable path items.
+
+#### Index Signature
+
+\[`name`: `string`\]: [`IOpenApiPathItem`](IOpenApiPathItem.md)
+
+***
+
+### mediaTypes? {#mediatypes}
+
+> `optional` **mediaTypes?**: `object`
+
+Reusable media types.
+
+#### Index Signature
+
+\[`name`: `string`\]: [`IOpenApiReference`](IOpenApiReference.md) \| [`IOpenApiMediaType`](IOpenApiMediaType.md)

package/docs/reference/interfaces/IOpenApiContact.md

@@ -0,0 +1,43 @@
+# Interface: IOpenApiContact
+
+An OpenAPI Contact Object.
+
+## See
+
+https://spec.openapis.org/oas/latest.html#contact-object
+
+## Properties
+
+### name? {#name}
+
+> `optional` **name?**: `string`
+
+The identifying name of the contact person or organisation.
+
+#### See
+
+https://spec.openapis.org/oas/latest.html#fixed-fields-1
+
+***
+
+### url? {#url}
+
+> `optional` **url?**: `string`
+
+The URI for the contact information.
+
+#### See
+
+https://spec.openapis.org/oas/latest.html#fixed-fields-1
+
+***
+
+### email? {#email}
+
+> `optional` **email?**: `string`
+
+The email address for the contact.
+
+#### See
+
+https://spec.openapis.org/oas/latest.html#fixed-fields-1

package/docs/reference/interfaces/IOpenApiExample.md

@@ -0,0 +1,55 @@
+# Interface: IOpenApiExample
+
+An OpenAPI Example Object.
+
+## See
+
+https://spec.openapis.org/oas/latest.html#example-object
+
+## Properties
+
+### summary? {#summary}
+
+> `optional` **summary?**: `string`
+
+Short description for the example.
+
+***
+
+### description? {#description}
+
+> `optional` **description?**: `string`
+
+Long description for the example.
+
+***
+
+### dataValue? {#datavalue}
+
+> `optional` **dataValue?**: `unknown`
+
+The schema-ready value for the example.
+
+***
+
+### serializedValue? {#serializedvalue}
+
+> `optional` **serializedValue?**: `string`
+
+The serialized form of the example.
+
+***
+
+### externalValue? {#externalvalue}
+
+> `optional` **externalValue?**: `string`
+
+An external URI for the serialized example.
+
+***
+
+### value? {#value}
+
+> `optional` **value?**: `unknown`
+
+Backwards-compatible embedded example value.

package/docs/reference/interfaces/IOpenApiExternalDocumentation.md

@@ -0,0 +1,23 @@
+# Interface: IOpenApiExternalDocumentation
+
+An OpenAPI External Documentation Object.
+
+## See
+
+https://spec.openapis.org/oas/latest.html#external-documentation-object
+
+## Properties
+
+### description? {#description}
+
+> `optional` **description?**: `string`
+
+A description of the target documentation.
+
+***
+
+### url {#url}
+
+> **url**: `string`
+
+The URI for the target documentation.

package/docs/reference/interfaces/IOpenApiHeader.md

@@ -0,0 +1,87 @@
+# Interface: IOpenApiHeader
+
+An OpenAPI Header Object.
+
+## See
+
+https://spec.openapis.org/oas/latest.html#header-object
+
+## Properties
+
+### description? {#description}
+
+> `optional` **description?**: `string`
+
+The description of the header.
+
+***
+
+### required? {#required}
+
+> `optional` **required?**: `boolean`
+
+Whether the header is required.
+
+***
+
+### deprecated? {#deprecated}
+
+> `optional` **deprecated?**: `boolean`
+
+Whether the header is deprecated.
+
+***
+
+### example? {#example}
+
+> `optional` **example?**: `unknown`
+
+A shorthand example for the header.
+
+***
+
+### examples? {#examples}
+
+> `optional` **examples?**: `object`
+
+Named examples for the header.
+
+#### Index Signature
+
+\[`id`: `string`\]: [`IOpenApiExample`](IOpenApiExample.md) \| [`IOpenApiReference`](IOpenApiReference.md)
+
+***
+
+### style? {#style}
+
+> `optional` **style?**: `"simple"`
+
+The serialization style for the header.
+
+***
+
+### explode? {#explode}
+
+> `optional` **explode?**: `boolean`
+
+Whether exploded serialization is used.
+
+***
+
+### schema? {#schema}
+
+> `optional` **schema?**: [`IJsonSchema`](IJsonSchema.md)
+
+The schema of the header.
+
+***
+
+### content? {#content}
+
+> `optional` **content?**: `object`
+
+The content definition for the header.
+
+#### Index Signature
+
+\[`contentType`: `string`\]: [`IOpenApiReference`](IOpenApiReference.md) \| [`IOpenApiMediaType`](IOpenApiMediaType.md)

package/docs/reference/interfaces/IOpenApiInfo.md

@@ -0,0 +1,91 @@
+# Interface: IOpenApiInfo
+
+An OpenAPI Info Object.
+
+## See
+
+https://spec.openapis.org/oas/latest.html#info-object
+
+## Properties
+
+### title {#title}
+
+> **title**: `string`
+
+The title of the API.
+
+#### See
+
+https://spec.openapis.org/oas/latest.html#fixed-fields-0
+
+***
+
+### summary? {#summary}
+
+> `optional` **summary?**: `string`
+
+A short summary of the API.
+
+#### See
+
+https://spec.openapis.org/oas/latest.html#fixed-fields-0
+
+***
+
+### description? {#description}
+
+> `optional` **description?**: `string`
+
+A description of the API.
+
+#### See
+
+https://spec.openapis.org/oas/latest.html#fixed-fields-0
+
+***
+
+### termsOfService? {#termsofservice}
+
+> `optional` **termsOfService?**: `string`
+
+The terms of service URI.
+
+#### See
+
+https://spec.openapis.org/oas/latest.html#fixed-fields-0
+
+***
+
+### contact? {#contact}
+
+> `optional` **contact?**: [`IOpenApiContact`](IOpenApiContact.md)
+
+Contact information for the API.
+
+#### See
+
+https://spec.openapis.org/oas/latest.html#fixed-fields-0
+
+***
+
+### license? {#license}
+
+> `optional` **license?**: [`IOpenApiLicense`](IOpenApiLicense.md)
+
+License information for the API.
+
+#### See
+
+https://spec.openapis.org/oas/latest.html#fixed-fields-0
+
+***
+
+### version {#version}
+
+> **version**: `string`
+
+The version of the API description.
+
+#### See
+
+https://spec.openapis.org/oas/latest.html#fixed-fields-0

package/docs/reference/interfaces/IOpenApiLicense.md

@@ -0,0 +1,43 @@
+# Interface: IOpenApiLicense
+
+An OpenAPI License Object.
+
+## See
+
+https://spec.openapis.org/oas/latest.html#license-object
+
+## Properties
+
+### name {#name}
+
+> **name**: `string`
+
+The license name.
+
+#### See
+
+https://spec.openapis.org/oas/latest.html#fixed-fields-2
+
+***
+
+### identifier? {#identifier}
+
+> `optional` **identifier?**: `string`
+
+The SPDX license expression.
+
+#### See
+
+https://spec.openapis.org/oas/latest.html#fixed-fields-2
+
+***
+
+### url? {#url}
+
+> `optional` **url?**: `string`
+
+The URI for the license.
+
+#### See
+
+https://spec.openapis.org/oas/latest.html#fixed-fields-2

package/docs/reference/interfaces/IOpenApiMediaType.md

@@ -0,0 +1,71 @@
+# Interface: IOpenApiMediaType
+
+An OpenAPI Media Type Object.
+
+## See
+
+https://spec.openapis.org/oas/latest.html#media-type-object
+
+## Properties
+
+### schema? {#schema}
+
+> `optional` **schema?**: [`IJsonSchema`](IJsonSchema.md)
+
+A schema describing the complete content.
+
+***
+
+### itemSchema? {#itemschema}
+
+> `optional` **itemSchema?**: [`IJsonSchema`](IJsonSchema.md)
+
+A schema describing each item within a sequential media type.
+
+***
+
+### example? {#example}
+
+> `optional` **example?**: `unknown`
+
+A single shorthand example.
+
+***
+
+### examples? {#examples}
+
+> `optional` **examples?**: `object`
+
+Named examples for the media type.
+
+#### Index Signature
+
+\[`id`: `string`\]: [`IOpenApiExample`](IOpenApiExample.md) \| [`IOpenApiReference`](IOpenApiReference.md)
+
+***
+
+### encoding? {#encoding}
+
+> `optional` **encoding?**: `object`
+
+Encoding metadata keyed by property name.
+
+#### Index Signature
+
+\[`id`: `string`\]: `unknown`
+
+***
+
+### prefixEncoding? {#prefixencoding}
+
+> `optional` **prefixEncoding?**: `unknown`[]
+
+Positional encoding metadata for multipart payloads.
+
+***
+
+### itemEncoding? {#itemencoding}
+
+> `optional` **itemEncoding?**: `unknown`
+
+Repeating item encoding metadata for multipart payloads.