@tsed/openspec 8.11.0 → 8.11.2-rc.1

package/src/openspec3/OS3Operation.ts

@@ -1,70 +0,0 @@
-import {OpenSpecExternalDocs} from "../common/OpenSpecExternalDocs.js";
-import {OpenSpecHash} from "../common/OpenSpecHash.js";
-import {OpenSpecSecurity} from "../common/OpenSpecSecurity.js";
-import {OS3Callbacks} from "./OS3Callbacks.js";
-import {OS3Parameter} from "./OS3Parameter.js";
-import {OS3RequestBody} from "./OS3RequestBody.js";
-import {OS3Response} from "./OS3Response.js";
-import {OS3Schema} from "./OS3Schema.js";
-import {OS3Server} from "./OS3Server.js";
-
-export interface OS3Operation<Schema = OS3Schema, Parameter = OS3Parameter<Schema>, Response = OpenSpecHash<OS3Response<Schema>>> {
-  /**
-   * Unique string used to identify the operation. The id MUST be unique among all operations described in the API. Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is RECOMMENDED to follow common programming naming conventions.
-   */
-  operationId: string;
-  /**
-   * A verbose explanation of the operation behavior. CommonMark syntax MAY be used for rich text representation.
-   */
-  description?: string;
-  /**
-   * A short summary of what the operation does.
-   */
-  summary?: string;
-  /**
-   * A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.
-   */
-  tags?: string[];
-  /**
-   * Additional external documentation for this operation.
-   */
-  externalDocs?: OpenSpecExternalDocs;
-  /**
-   * A list of parameters that are applicable for this operation. If a parameter is already defined at the [Path Item](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md#pathItemParameters),
-   * 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](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md#parameterName) and (location)[https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md#parameterIn].
-   * The list can use the [Reference Object](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md#referenceObject) to link to parameters that are defined at the [OpenAPI Object's components/parameters](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md#componentsParameters).
-   */
-  parameters?: Parameter[];
-  /**
-   * The request body applicable for this operation.
-   * The requestBody is only supported in HTTP methods where the HTTP 1.1 specification [RFC7231](https://tools.ietf.org/html/rfc7231#section-4.3.1) has explicitly defined semantics for request bodies.
-   * In other cases where the HTTP spec is vague, requestBody SHALL be ignored by consumers.
-   */
-  requestBody?: OS3RequestBody<Schema>;
-  /**
-   * The list of possible responses as they are returned from executing this operation.
-   */
-  responses: Response;
-  /**
-   * Declares this operation to be deprecated. Consumers SHOULD refrain from usage of the declared operation. Default value is false.
-   */
-  deprecated?: boolean;
-  /**
-   * 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.
-   * This definition overrides any declared top-level [security](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md#oasSecurity). To remove a top-level security declaration, an empty array can be used.
-   */
-  security?: OpenSpecSecurity;
-  /**
-   * An alternative server array to service this operation. If an alternative server object is specified at the Path Item Object or Root level, it will be overridden by this value.
-   */
-  servers?: OS3Server[];
-  /**
-   * A map of possible out-of band callbacks related to the parent operation.
-   * The key is a unique identifier for the [Callback Object](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md#callbackObject).
-   * Each value in the map is a Callback Object that describes a request that may be initiated by the API provider and the expected responses.
-   * The key value used to identify the callback object is an expression, evaluated at runtime, that identifies a URL to use for the callback operation.
-   */
-  callbacks?: OS3Callbacks<Schema>;
-}

package/src/openspec3/OS3Parameter.ts

@@ -1,83 +0,0 @@
-import {OpenSpecHash} from "../common/OpenSpecHash.js";
-import {OpenSpecRef} from "../common/OpenSpecRef.js";
-import {OS3Example} from "./OS3Example.js";
-import {OS3MediaType} from "./OS3MediaType.js";
-import {OS3Schema} from "./OS3Schema.js";
-
-export type OS3StyleParameter = "matrix" | "label" | "form" | "simple" | "spaceDelimited" | "pipeDelimited" | "deepObject";
-
-export interface OS3Parameter<Schema = OS3Schema> {
-  /**
-   *The name of the parameter. Parameter names are case sensitive.
-   *
-   * - If [`in`](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md#parameterIn) is `"path"`, the `name` field MUST correspond to the associated [path](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md#pathsPath) segment from the path field in the [Paths Object](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md#pathsObject). See [Path Templating](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md#pathTemplating) for further information.
-   * - If [`in`](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md#parameterIn) is `"header"` and the `name` field is `"Accept"`, `"Content-Type"` or `"Authorization"`, the parameter definition SHALL be ignored.
-   * - For all other cases, the `name` corresponds to the parameter name used by the [`in`](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md#parameterIn) property.
-   */
-  name: string;
-  /**
-   * The location of the parameter. Possible values are `"query"`, `"header"`, `"path"` or `"cookie"`.
-   */
-  in: "path" | "query" | "header" | "cookie";
-  /**
-   * Determines whether this parameter is mandatory. If the [parameter location](Determines whether this parameter is mandatory.
-   * If the parameter location is `"path"`, this property is **REQUIRED** and its value MUST be `true`.
-   * Otherwise, the property MAY be included and its default value is false.) is `"path"`, this property is **REQUIRED** and its value MUST be `true`.
-   * Otherwise, the property MAY be included and its default value is `false`.
-   */
-  required: boolean;
-  /**
-   * A brief description of the parameter. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.
-   */
-  description?: string;
-  /**
-   * Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.
-   */
-  deprecated?: boolean;
-  /**
-   * Sets the ability to pass empty-valued parameters.
-   * This is valid only for query parameters and allows sending a parameter with an empty value.
-   * Default value is `false`.
-   * If style is used, and if behavior is `n/a` (cannot be serialized), the value of `allowEmptyValue` SHALL be ignored.
-   */
-  allowEmptyValue?: boolean;
-  /**
-   * The schema defining the type used for the parameter.
-   */
-  schema?: OS3Schema | OpenSpecRef;
-  /**
-   * Describes how the parameter value will be serialized depending on the type of the parameter value.
-   * Default values (based on value of in): for `query` - `form`; for `path` - `simple`; for `header` - `simple`; for `cookie` - `form`.
-   * See [style values](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md#style-values).
-   */
-  style?: OS3StyleParameter;
-  /**
-   * When this is true, parameter values of type array or object generate separate parameters for each value of the array or key-value pair of the map.
-   * For other types of parameters this property has no effect. When style is form, the default value is true. For all other styles, the default value is false.
-   */
-  explode?: boolean;
-  /**
-   * Determines whether the parameter value SHOULD allow reserved characters, as defined by [RFC3986](https://tools.ietf.org/html/rfc3986#section-2.2) `:/?#[]@!$&'()*+,;=` to be included without percent-encoding.
-   * This property only applies to parameters with an `in` value of `query`. The default value is `false`.
-   */
-  allowReserved?: boolean;
-  /**
-   * Example of the media type.
-   * The `example` SHOULD match the specified schema and encoding properties if present.
-   * The `example` field is mutually exclusive of the `examples` field.
-   * Furthermore, if referencing a `schema` which contains an example, the `example` value SHALL override the example provided by the schema.
-   * To represent examples of media types that cannot naturally be represented in JSON or YAML, a string value can contain the example with escaping where necessary.
-   */
-  example?: any;
-  /**
-   * Examples of the media type.
-   * Each example SHOULD contain a value in the correct format as specified in the parameter encoding.
-   * The `examples` field is mutually exclusive of the `example` field.
-   * Furthermore, if referencing a `schema` which contains an example, the examples value SHALL override the example provided by the schema.
-   */
-  examples?: OpenSpecHash<OS3Example | OpenSpecRef>;
-  /***
-   * A map containing the representations for the parameter. The key is the media type and the value describes it. The map MUST only contain one entry.
-   */
-  content?: OpenSpecHash<OS3MediaType>;
-}

package/src/openspec3/OS3Paths.ts

@@ -1,29 +0,0 @@
-import {OpenSpecPath} from "../common/OpenSpecPath.js";
-import {OpenSpecRef} from "../common/OpenSpecRef.js";
-import {OS3Operation} from "./OS3Operation.js";
-import {OS3Parameter} from "./OS3Parameter.js";
-import {OS3Schema} from "./OS3Schema.js";
-import {OS3Server} from "./OS3Server.js";
-
-export interface OS3Paths<Schema = OS3Schema> extends OpenSpecPath<OS3Operation<Schema>> {
-  /**
-   * An optional, string summary, intended to apply to all operations in this path.
-   */
-  summary?: string;
-  /**
-   * An optional, string description, intended to apply to all operations in this path. CommonMark syntax MAY be used for rich text representation.
-   */
-  description?: string;
-  /**
-   * A definition of a TRACE operation on this path.
-   */
-  trace?: OS3Operation<Schema>;
-  /**
-   * An alternative server array to service all operations in this path.
-   */
-  servers?: OS3Server[];
-  /**
-   * A list of parameters that are applicable for all the operations described under this path. These parameters can be overridden at the operation level, but cannot be removed there. 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 at the OpenAPI Object's components/parameters.
-   */
-  parameters?: (OS3Parameter<Schema> | OpenSpecRef)[];
-}

package/src/openspec3/OS3RequestBody.ts

@@ -1,22 +0,0 @@
-import {OpenSpecHash} from "../common/OpenSpecHash.js";
-import {OpenSpecRef} from "../common/OpenSpecRef.js";
-import {OS3Example} from "./OS3Example.js";
-import {OS3MediaType} from "./OS3MediaType.js";
-import {OS3Schema} from "./OS3Schema.js";
-
-export interface OS3RequestBody<Schema = OS3Schema> {
-  /**
-   * A brief description of the request body. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.
-   */
-  description?: string;
-  /**
-   * A map containing descriptions of potential request body. The key is a media type or [media type range](https://tools.ietf.org/html/rfc7231#appendix-D) and the value describes it. For responses that match multiple keys, only the most specific key is applicable. e.g. text/plain overrides text/*
-   */
-  content?: OpenSpecHash<OS3MediaType<Schema>>;
-  /**
-   * Determines if the request body is required in the request. Defaults to false.
-   */
-  required?: boolean;
-
-  examples?: OpenSpecHash<OS3Example | OpenSpecRef>;
-}

package/src/openspec3/OS3Response.ts

@@ -1,25 +0,0 @@
-import {OpenSpecHash} from "../common/OpenSpecHash.js";
-import {OpenSpecRef} from "../common/OpenSpecRef.js";
-import {OS3Header} from "./OS3Header.js";
-import {OS3Link} from "./OS3Link.js";
-import {OS3MediaType} from "./OS3MediaType.js";
-import {OS3Schema} from "./OS3Schema.js";
-
-export interface OS3Response<Schema = OS3Schema, Header = OS3Header<Schema>> {
-  /**
-   * A short description of the response. CommonMark syntax MAY be used for rich text representation.
-   */
-  description: string;
-  /**
-   * Maps a header name to its definition. [RFC7230](https://tools.ietf.org/html/rfc7230#page-22) states header names are case insensitive. If a response header is defined with the name "Content-Type", it SHALL be ignored.
-   */
-  headers?: OpenSpecHash<Header>;
-  /**
-   * A map containing descriptions of potential response payloads. The key is a media type or [media type range](https://tools.ietf.org/html/rfc7231#appendix-D) and the value describes it. For responses that match multiple keys, only the most specific key is applicable. e.g. text/plain overrides text/*
-   */
-  content?: OpenSpecHash<OS3MediaType<Schema>>;
-  /**
-   * 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](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md#componentsObject).
-   */
-  links?: OpenSpecHash<OS3Link | OpenSpecRef>;
-}

package/src/openspec3/OS3Schema.ts

@@ -1,51 +0,0 @@
-import {OpenSpecExternalDocs} from "../common/OpenSpecExternalDocs.js";
-import {OpenSpecBaseJsonSchema, OpenSpecJsonSchema} from "../common/OpenSpecJsonSchema.js";
-import {OpenSpecRef} from "../common/OpenSpecRef.js";
-import {OpenSpecXML} from "../common/OpenSpecXML.js";
-
-export interface OS3BaseSchema extends OpenSpecBaseJsonSchema {
-  /**
-   * Required if type is "array". Describes the type of items in the array.
-   */
-  items?: OS3Schema | OpenSpecRef;
-}
-
-export interface OS3Schema extends OpenSpecJsonSchema<OS3Schema> {
-  /**
-   * Inline or referenced schema MUST be of a [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md#schemaObject) and not a standard JSON Schema.
-   */
-  oneOf?: (OS3Schema | OpenSpecRef)[];
-  /**
-   * Inline or referenced schema MUST be of a [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md#schemaObject) and not a standard JSON Schema.
-   */
-  anyOf?: (OS3Schema | OpenSpecRef)[];
-  /**
-   * Inline or referenced schema MUST be of a [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md#schemaObject) and not a standard JSON Schema.
-   */
-  not?: OS3Schema | OpenSpecRef;
-  /**
-   * Allows sending a null value for the defined schema. Default value is false.
-   */
-  nullable?: boolean;
-  /**
-   * Adds support for polymorphism.
-   * The discriminator is the schema property name that is used to differentiate between other schema that inherit this schema. The property name used MUST be defined at this schema and it MUST be in the required property list. When used, the value MUST be the name of this schema or any schema that inherits it.
-   */
-  discriminator?: string;
-  /**
-   * Relevant only for Schema "properties" definitions. Declares the property as "read only". This means that it MAY be sent as part of a response but MUST NOT be sent as part of the request. Properties marked as readOnly being true SHOULD NOT be in the required list of the defined schema. Default value is false.
-   */
-  readOnly?: boolean;
-  /**
-   * Relevant only for Schema "properties" definitions. Declares the property as "write only". Therefore, it MAY be sent as part of a request but SHOULD NOT be sent as part of the response. If the property is marked as writeOnly being true and is in the required list, the required will take effect on the request only. A property MUST NOT be marked as both readOnly and writeOnly being true. Default value is false.
-   */
-  writeOnly?: boolean;
-  /**
-   * This MAY be used only on properties schemas. It has no effect on root schemas. Adds Additional metadata to describe the XML representation format of this property.
-   */
-  xml?: OpenSpecXML;
-  /**
-   * Additional external documentation for this schema.
-   */
-  externalDocs?: OpenSpecExternalDocs;
-}

package/src/openspec3/OS3Security.ts

@@ -1,63 +0,0 @@
-import {OS3Flows} from "./OS3Flows.js";
-
-export interface OS3SecurityBase {
-  /**
-   * The type of the security scheme
-   */
-  type: "apiKey" | "oauth2" | "http" | "openIdConnect";
-  /**
-   *
-   */
-  description?: string;
-}
-
-export interface OS3SecurityApiKey extends OS3SecurityBase {
-  /**
-   * The type of the security scheme
-   */
-  type: "apiKey";
-  /**
-   * The name of the header, query or cookie parameter to be used.
-   */
-  name: string;
-  /**
-   * The location of the API key. Valid values are `query`, `header` or `cookie`.
-   */
-  in: "query" | "header" | "cookie";
-}
-
-export interface OS3SecurityOAuth2 extends OS3SecurityBase {
-  /**
-   * The type of the security scheme
-   */
-  type: "oauth2";
-  /**
-   * An object containing configuration information for the flow types supported.
-   */
-  flows: OS3Flows;
-}
-
-export interface OS3SecurityOpenIDConnect extends OS3SecurityBase {
-  /**
-   * The type of the security scheme
-   */
-  type: "openIdConnect";
-  openIdConnectUrl: string;
-}
-
-export interface OS3SecurityHTTP extends OS3SecurityBase {
-  /**
-   * The type of the security scheme
-   */
-  type: "http";
-  /**
-   * The name of the HTTP Authorization scheme to be used in the [Authorization header as defined in RFC7235](https://tools.ietf.org/html/rfc7235#section-5.1).
-   */
-  scheme: string;
-  /**
-   * A hint to the client to identify how the bearer token is formatted. Bearer tokens are usually generated by an authorization server, so this information is primarily for documentation purposes.
-   */
-  bearerFormat?: string;
-}
-
-export type OS3Security = OS3SecurityApiKey | OS3SecurityHTTP | OS3SecurityOAuth2 | OS3SecurityOpenIDConnect;

package/src/openspec3/OS3Server.ts

@@ -1,31 +0,0 @@
-import {OpenSpecHash} from "../common/OpenSpecHash.js";
-
-export interface OpenSpecServerVariable {
-  /**
-   * An enumeration of string values to be used if the substitution options are from a limited set.
-   */
-  enum?: string;
-  /**
-   * The default value to use for substitution, and to send, if an alternate value is not supplied. Unlike the Schema Object's default, this value MUST be provided by the consumer.
-   */
-  default: string;
-  /**
-   * An optional description for the server variable. CommonMark syntax MAY be used for rich text representation.
-   */
-  description?: string;
-}
-
-export interface OS3Server {
-  /**
-   * A URL to the target host. This URL supports Server Variables and MAY be relative, to indicate that the host location is relative to the location where the OpenAPI document is being served. Variable substitutions will be made when a variable is named in `{brackets}`.
-   */
-  url: string;
-  /**
-   * An optional string describing the host designated by the URL. CommonMark syntax MAY be used for rich text representation.
-   */
-  description: string;
-  /**
-   * A map between a variable name and its value. The value is used for substitution in the server's URL template.
-   */
-  variables?: OpenSpecHash<OpenSpecServerVariable>;
-}

package/src/openspec3/OpenSpec3.ts

@@ -1,44 +0,0 @@
-import {OpenSpecExternalDocs} from "../common/OpenSpecExternalDocs.js";
-import {OpenSpecHash} from "../common/OpenSpecHash.js";
-import {OpenSpecInfo} from "../common/OpenSpecInfo.js";
-import {OpenSpecSecurity} from "../common/OpenSpecSecurity.js";
-import {OpenSpecTag} from "../common/OpenSpecTag.js";
-import {OS3Components} from "./OS3Components.js";
-import {OS3Paths} from "./OS3Paths.js";
-import {OS3Schema} from "./OS3Schema.js";
-import {OS3Server} from "./OS3Server.js";
-
-export interface OpenSpec3<Schema = OS3Schema> {
-  /**
-   * This string MUST be the semantic version number of the OpenAPI Specification version that the OpenAPI document uses. The openapi field SHOULD be used by tooling specifications and clients to interpret the OpenAPI document. This is not related to the API info.version string.
-   */
-  openapi: string;
-  /**
-   * Provides metadata about the API. The metadata MAY be used by tooling as required.
-   */
-  info: OpenSpecInfo;
-  /**
-   * An array of Server Objects, which provide connectivity information to a target server. If the servers property is not provided, or is an empty array, the default value would be a Server Object with a url value of /.
-   */
-  servers?: OS3Server[];
-  /**
-   * The available paths and operations for the API.
-   */
-  paths: OpenSpecHash<OS3Paths<Schema>>;
-  /**
-   * An element to hold various schemas for the specification.
-   */
-  components?: OS3Components<Schema>;
-  /**
-   * 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.
-   */
-  security?: OpenSpecSecurity;
-  /**
-   * A list of tags used by the specification 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.
-   */
-  tags?: OpenSpecTag[];
-  /**
-   * Additional external documentation.
-   */
-  externalDocs?: OpenSpecExternalDocs;
-}