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

package/docs/reference/interfaces/IOpenApiOAuthFlow.md

@@ -0,0 +1,51 @@
+# Interface: IOpenApiOAuthFlow
+
+An OpenAPI OAuth Flow Object.
+
+## See
+
+https://spec.openapis.org/oas/latest.html#oauth-flow-object
+
+## Properties
+
+### authorizationUrl? {#authorizationurl}
+
+> `optional` **authorizationUrl?**: `string`
+
+The authorization URL for this flow.
+
+***
+
+### deviceAuthorizationUrl? {#deviceauthorizationurl}
+
+> `optional` **deviceAuthorizationUrl?**: `string`
+
+The device authorization URL for this flow.
+
+***
+
+### tokenUrl? {#tokenurl}
+
+> `optional` **tokenUrl?**: `string`
+
+The token URL for this flow.
+
+***
+
+### refreshUrl? {#refreshurl}
+
+> `optional` **refreshUrl?**: `string`
+
+The refresh URL for this flow.
+
+***
+
+### scopes {#scopes}
+
+> **scopes**: `object`
+
+Available scopes for this flow.
+
+#### Index Signature
+
+\[`name`: `string`\]: `string`

package/docs/reference/interfaces/IOpenApiOAuthFlows.md

@@ -0,0 +1,47 @@
+# Interface: IOpenApiOAuthFlows
+
+An OpenAPI OAuth Flows Object.
+
+## See
+
+https://spec.openapis.org/oas/latest.html#oauth-flows-object
+
+## Properties
+
+### implicit? {#implicit}
+
+> `optional` **implicit?**: [`IOpenApiOAuthFlow`](IOpenApiOAuthFlow.md)
+
+Configuration for the implicit flow.
+
+***
+
+### password? {#password}
+
+> `optional` **password?**: [`IOpenApiOAuthFlow`](IOpenApiOAuthFlow.md)
+
+Configuration for the resource owner password flow.
+
+***
+
+### clientCredentials? {#clientcredentials}
+
+> `optional` **clientCredentials?**: [`IOpenApiOAuthFlow`](IOpenApiOAuthFlow.md)
+
+Configuration for the client credentials flow.
+
+***
+
+### authorizationCode? {#authorizationcode}
+
+> `optional` **authorizationCode?**: [`IOpenApiOAuthFlow`](IOpenApiOAuthFlow.md)
+
+Configuration for the authorization code flow.
+
+***
+
+### deviceAuthorization? {#deviceauthorization}
+
+> `optional` **deviceAuthorization?**: [`IOpenApiOAuthFlow`](IOpenApiOAuthFlow.md)
+
+Configuration for the device authorization flow.

package/docs/reference/interfaces/IOpenApiParameter.md

@@ -0,0 +1,119 @@
+# Interface: IOpenApiParameter
+
+An OpenAPI Parameter Object.
+
+## See
+
+https://spec.openapis.org/oas/latest.html#parameter-object
+
+## Properties
+
+### name {#name}
+
+> **name**: `string`
+
+The name of the parameter.
+
+***
+
+### in {#in}
+
+> **in**: [`OpenApiParameterLocation`](../type-aliases/OpenApiParameterLocation.md)
+
+The location of the parameter.
+
+***
+
+### description? {#description}
+
+> `optional` **description?**: `string`
+
+A brief description of the parameter.
+
+***
+
+### required? {#required}
+
+> `optional` **required?**: `boolean`
+
+Whether the parameter is required.
+
+***
+
+### deprecated? {#deprecated}
+
+> `optional` **deprecated?**: `boolean`
+
+Whether the parameter is deprecated.
+
+***
+
+### allowEmptyValue? {#allowemptyvalue}
+
+> `optional` **allowEmptyValue?**: `boolean`
+
+Whether empty values are allowed for query parameters.
+
+***
+
+### example? {#example}
+
+> `optional` **example?**: `unknown`
+
+A shorthand example for the parameter.
+
+***
+
+### examples? {#examples}
+
+> `optional` **examples?**: `object`
+
+Named examples for the parameter.
+
+#### Index Signature
+
+\[`id`: `string`\]: [`IOpenApiExample`](IOpenApiExample.md) \| [`IOpenApiReference`](IOpenApiReference.md)
+
+***
+
+### style? {#style}
+
+> `optional` **style?**: [`OpenApiParameterStyle`](../type-aliases/OpenApiParameterStyle.md)
+
+The serialization style for the parameter.
+
+***
+
+### explode? {#explode}
+
+> `optional` **explode?**: `boolean`
+
+Whether exploded serialization is used.
+
+***
+
+### allowReserved? {#allowreserved}
+
+> `optional` **allowReserved?**: `boolean`
+
+Whether reserved characters may pass through unchanged.
+
+***
+
+### schema? {#schema}
+
+> `optional` **schema?**: [`IJsonSchema`](IJsonSchema.md)
+
+The schema describing the parameter.
+
+***
+
+### content? {#content}
+
+> `optional` **content?**: `object`
+
+Content-based parameter serialization.
+
+#### Index Signature
+
+\[`contentType`: `string`\]: [`IOpenApiReference`](IOpenApiReference.md) \| [`IOpenApiMediaType`](IOpenApiMediaType.md)

package/docs/reference/interfaces/IOpenApiPathItem.md

@@ -0,0 +1,131 @@
+# Interface: IOpenApiPathItem
+
+An OpenAPI Path Item Object.
+
+## See
+
+https://spec.openapis.org/oas/latest.html#path-item-object
+
+## Properties
+
+### $ref? {#ref}
+
+> `optional` **$ref?**: `string`
+
+A referenced definition of this path item.
+
+***
+
+### summary? {#summary}
+
+> `optional` **summary?**: `string`
+
+A summary applying to all operations in the path.
+
+***
+
+### description? {#description}
+
+> `optional` **description?**: `string`
+
+A description applying to all operations in the path.
+
+***
+
+### get? {#get}
+
+> `optional` **get?**: [`IOpenApiPathMethod`](IOpenApiPathMethod.md)
+
+A GET operation on the path.
+
+***
+
+### put? {#put}
+
+> `optional` **put?**: [`IOpenApiPathMethod`](IOpenApiPathMethod.md)
+
+A PUT operation on the path.
+
+***
+
+### post? {#post}
+
+> `optional` **post?**: [`IOpenApiPathMethod`](IOpenApiPathMethod.md)
+
+A POST operation on the path.
+
+***
+
+### delete? {#delete}
+
+> `optional` **delete?**: [`IOpenApiPathMethod`](IOpenApiPathMethod.md)
+
+A DELETE operation on the path.
+
+***
+
+### options? {#options}
+
+> `optional` **options?**: [`IOpenApiPathMethod`](IOpenApiPathMethod.md)
+
+An OPTIONS operation on the path.
+
+***
+
+### head? {#head}
+
+> `optional` **head?**: [`IOpenApiPathMethod`](IOpenApiPathMethod.md)
+
+A HEAD operation on the path.
+
+***
+
+### patch? {#patch}
+
+> `optional` **patch?**: [`IOpenApiPathMethod`](IOpenApiPathMethod.md)
+
+A PATCH operation on the path.
+
+***
+
+### trace? {#trace}
+
+> `optional` **trace?**: [`IOpenApiPathMethod`](IOpenApiPathMethod.md)
+
+A TRACE operation on the path.
+
+***
+
+### query? {#query}
+
+> `optional` **query?**: [`IOpenApiPathMethod`](IOpenApiPathMethod.md)
+
+A QUERY operation on the path.
+
+***
+
+### additionalOperations? {#additionaloperations}
+
+> `optional` **additionalOperations?**: `object`
+
+Additional non-standard HTTP operations keyed by method name.
+
+#### Index Signature
+
+\[`method`: `string`\]: [`IOpenApiPathMethod`](IOpenApiPathMethod.md)
+
+***
+
+### servers? {#servers}
+
+> `optional` **servers?**: [`IOpenApiServer`](IOpenApiServer.md)[]
+
+Alternative servers for this path.
+
+***
+
+### parameters? {#parameters}
+
+> `optional` **parameters?**: ([`IOpenApiReference`](IOpenApiReference.md) \| [`IOpenApiParameter`](IOpenApiParameter.md))[]
+
+Shared parameters for all operations on this path.

package/docs/reference/interfaces/IOpenApiPathMethod.md

@@ -0,0 +1,155 @@
+# Interface: IOpenApiPathMethod
+
+An OpenAPI Operation Object.
+
+## See
+
+https://spec.openapis.org/oas/latest.html#operation-object
+
+## Properties
+
+### tags? {#tags}
+
+> `optional` **tags?**: `string`[]
+
+Tags for the operation.
+
+#### See
+
+https://spec.openapis.org/oas/latest.html#fixed-fields-7
+
+***
+
+### summary? {#summary}
+
+> `optional` **summary?**: `string`
+
+A short summary of the operation.
+
+#### See
+
+https://spec.openapis.org/oas/latest.html#fixed-fields-7
+
+***
+
+### description? {#description}
+
+> `optional` **description?**: `string`
+
+A verbose description of the operation.
+
+#### See
+
+https://spec.openapis.org/oas/latest.html#fixed-fields-7
+
+***
+
+### externalDocs? {#externaldocs}
+
+> `optional` **externalDocs?**: [`IOpenApiExternalDocumentation`](IOpenApiExternalDocumentation.md)
+
+Additional external documentation for the operation.
+
+#### See
+
+https://spec.openapis.org/oas/latest.html#fixed-fields-7
+
+***
+
+### operationId? {#operationid}
+
+> `optional` **operationId?**: `string`
+
+A unique identifier for the operation.
+
+#### See
+
+https://spec.openapis.org/oas/latest.html#fixed-fields-7
+
+***
+
+### parameters? {#parameters}
+
+> `optional` **parameters?**: ([`IOpenApiReference`](IOpenApiReference.md) \| [`IOpenApiParameter`](IOpenApiParameter.md))[]
+
+Parameters for the operation.
+
+#### See
+
+https://spec.openapis.org/oas/latest.html#fixed-fields-7
+
+***
+
+### requestBody? {#requestbody}
+
+> `optional` **requestBody?**: [`IOpenApiReference`](IOpenApiReference.md) \| [`IOpenApiRequestBody`](IOpenApiRequestBody.md)
+
+The request body for the operation.
+
+#### See
+
+https://spec.openapis.org/oas/latest.html#fixed-fields-7
+
+***
+
+### responses {#responses}
+
+> **responses**: [`IOpenApiResponses`](IOpenApiResponses.md)
+
+The responses for the operation.
+
+#### See
+
+https://spec.openapis.org/oas/latest.html#fixed-fields-7
+
+***
+
+### callbacks? {#callbacks}
+
+> `optional` **callbacks?**: `object`
+
+Callbacks related to the operation.
+
+#### Index Signature
+
+\[`id`: `string`\]: `unknown`
+
+#### See
+
+https://spec.openapis.org/oas/latest.html#fixed-fields-7
+
+***
+
+### deprecated? {#deprecated}
+
+> `optional` **deprecated?**: `boolean`
+
+Whether the operation is deprecated.
+
+#### See
+
+https://spec.openapis.org/oas/latest.html#fixed-fields-7
+
+***
+
+### security? {#security}
+
+> `optional` **security?**: [`IOpenApiSecurityRequirement`](IOpenApiSecurityRequirement.md)[]
+
+Security requirements for the operation.
+
+#### See
+
+https://spec.openapis.org/oas/latest.html#fixed-fields-7
+
+***
+
+### servers? {#servers}
+
+> `optional` **servers?**: [`IOpenApiServer`](IOpenApiServer.md)[]
+
+Alternative servers for the operation.
+
+#### See
+
+https://spec.openapis.org/oas/latest.html#fixed-fields-7

package/docs/reference/interfaces/IOpenApiReference.md

@@ -0,0 +1,31 @@
+# Interface: IOpenApiReference
+
+An OpenAPI Reference Object.
+
+## See
+
+https://spec.openapis.org/oas/latest.html#reference-object
+
+## Properties
+
+### $ref {#ref}
+
+> **$ref**: `string`
+
+The reference identifier.
+
+***
+
+### summary? {#summary}
+
+> `optional` **summary?**: `string`
+
+A summary override for the referenced object.
+
+***
+
+### description? {#description}
+
+> `optional` **description?**: `string`
+
+A description override for the referenced object.

package/docs/reference/interfaces/IOpenApiRequestBody.md

@@ -0,0 +1,35 @@
+# Interface: IOpenApiRequestBody
+
+An OpenAPI Request Body Object.
+
+## See
+
+https://spec.openapis.org/oas/latest.html#request-body-object
+
+## Properties
+
+### description? {#description}
+
+> `optional` **description?**: `string`
+
+A brief description of the request body.
+
+***
+
+### content {#content}
+
+> **content**: `object`
+
+The content of the request body.
+
+#### Index Signature
+
+\[`contentType`: `string`\]: [`IOpenApiReference`](IOpenApiReference.md) \| [`IOpenApiMediaType`](IOpenApiMediaType.md)
+
+***
+
+### required? {#required}
+
+> `optional` **required?**: `boolean`
+
+Whether the request body is required.

package/docs/reference/interfaces/IOpenApiResponse.md

@@ -0,0 +1,59 @@
+# Interface: IOpenApiResponse
+
+An OpenAPI Response Object.
+
+## See
+
+https://spec.openapis.org/oas/latest.html#response-object
+
+## Properties
+
+### summary? {#summary}
+
+> `optional` **summary?**: `string`
+
+A short summary of the meaning of the response.
+
+***
+
+### description {#description}
+
+> **description**: `string`
+
+A description of the response.
+
+***
+
+### headers? {#headers}
+
+> `optional` **headers?**: `object`
+
+The headers for the response.
+
+#### Index Signature
+
+\[`id`: `string`\]: [`IOpenApiReference`](IOpenApiReference.md) \| [`IOpenApiHeader`](IOpenApiHeader.md)
+
+***
+
+### content? {#content}
+
+> `optional` **content?**: `object`
+
+The content for the response.
+
+#### Index Signature
+
+\[`contentType`: `string`\]: [`IOpenApiReference`](IOpenApiReference.md) \| [`IOpenApiMediaType`](IOpenApiMediaType.md)
+
+***
+
+### links? {#links}
+
+> `optional` **links?**: `object`
+
+Design-time links from this response.
+
+#### Index Signature
+
+\[`id`: `string`\]: `unknown`

package/docs/reference/interfaces/IOpenApiResponses.md

@@ -0,0 +1,29 @@
+# Interface: IOpenApiResponses
+
+An OpenAPI Responses Object.
+
+## See
+
+https://spec.openapis.org/oas/latest.html#responses-object
+
+## Indexable
+
+> \[`code`: `string`\]: [`IOpenApiReference`](IOpenApiReference.md) \| [`IOpenApiResponse`](IOpenApiResponse.md) \| `undefined`
+
+Named HTTP status code or status code range responses.
+
+### See
+
+https://spec.openapis.org/oas/latest.html#patterned-fields-0
+
+## Properties
+
+### default? {#default}
+
+> `optional` **default?**: [`IOpenApiReference`](IOpenApiReference.md) \| [`IOpenApiResponse`](IOpenApiResponse.md)
+
+The default response for otherwise undeclared status codes.
+
+#### See
+
+https://spec.openapis.org/oas/latest.html#fixed-fields-13

package/docs/reference/interfaces/IOpenApiSecurityRequirement.md

@@ -0,0 +1,11 @@
+# Interface: IOpenApiSecurityRequirement
+
+An OpenAPI Security Requirement Object.
+
+## See
+
+https://spec.openapis.org/oas/latest.html#security-requirement-object
+
+## Indexable
+
+> \[`name`: `string`\]: `string`[]