@tsed/openspec 8.0.0 → 8.0.2

package/package.json

@@ -2,13 +2,14 @@
   "name": "@tsed/openspec",
   "description": "OpenSpec2 and OpenSpec3 interfaces declarations for TypeScript application",
   "type": "module",
-  "version": "8.0.0",
+  "version": "8.0.2",
   "source": "./src/index.ts",
   "main": "./lib/esm/index.js",
   "module": "./lib/esm/index.js",
   "typings": "./lib/types/index.d.ts",
   "exports": {
     ".": {
+      "@tsed/source": "./src/index.ts",
       "types": "./lib/types/index.d.ts",
       "import": "./lib/esm/index.js",
       "default": "./lib/esm/index.js"
@@ -30,8 +31,8 @@
     "JsonSchema"
   ],
   "devDependencies": {
-    "@tsed/barrels": "8.0.0",
-    "@tsed/typescript": "8.0.0",
+    "@tsed/barrels": "8.0.2",
+    "@tsed/typescript": "8.0.2",
     "eslint": "9.12.0",
     "typescript": "5.4.5"
   },

package/src/common/OpenSpecExternalDocs.ts

@@ -0,0 +1,10 @@
+export interface OpenSpecExternalDocs {
+  /**
+   * The URL for the target documentation. Value MUST be in the format of a URL.
+   */
+  url: string;
+  /**
+   * A short description of the target documentation. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation.
+   */
+  description?: string;
+}

package/src/common/OpenSpecHash.ts

@@ -0,0 +1 @@
+export type OpenSpecHash<T> = Record<string, T>;

package/src/common/OpenSpecInfo.ts

@@ -0,0 +1,52 @@
+export interface OpenSpecContact {
+  /**
+   * The identifying name of the contact person/organization.
+   */
+  name?: string;
+  /**
+   * The email address of the contact person/organization. MUST be in the format of an email address.
+   */
+  email?: string;
+  /**
+   * The URL pointing to the contact information. MUST be in the format of a URL.
+   */
+  url?: string;
+}
+
+export interface OpenSpecLicense {
+  /**
+   * The license name used for the API.
+   */
+  name: string;
+  /**
+   * A URL to the license used for the API. MUST be in the format of a URL.
+   */
+  url?: string;
+}
+
+export interface OpenSpecInfo {
+  /**
+   * The title of the application.
+   */
+  title: string;
+  /**
+   * The version of the OpenAPI document (which is distinct from the [OpenAPI Specification](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md#oasVersion) version or the API implementation version).
+   */
+  version: string;
+  /**
+   * A short description of the application. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation.
+   */
+  description?: string;
+  /**
+   * A URL to the Terms of Service for the API. MUST be in the format of a URL.
+   */
+  termsOfService?: string;
+  /**
+   * The contact information for the exposed API.
+   */
+  contact?: OpenSpecContact;
+  /**
+   * The license information for the exposed API.
+   */
+  license?: OpenSpecLicense;
+}

package/src/common/OpenSpecJsonSchema.ts

@@ -0,0 +1,153 @@
+import {OpenSpecHash} from "./OpenSpecHash.js";
+import {OpenSpecRef} from "./OpenSpecRef.js";
+import {OpenSpecTypes} from "./OpenSpecTypes.js";
+
+export interface OpenSpecBaseJsonSchema {
+  $ref?: string;
+  /**
+   * This attribute is a string that provides a short description of the instance property.
+   *
+   * @see https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-7.2
+   */
+  title?: string;
+  /**
+   * Must be strictly greater than 0.
+   * A numeric instance is valid only if division by this keyword's value results in an integer.
+   * @see https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.1
+   */
+  multipleOf?: number;
+  /**
+   * Representing an inclusive upper limit for a numeric instance.
+   * This keyword validates only if the instance is less than or exactly equal to "maximum".
+   * @see https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.2
+   */
+  maximum?: number;
+  /**
+   * Representing an exclusive upper limit for a numeric instance.
+   * This keyword validates only if the instance is strictly less than (not equal to) to "exclusiveMaximum".
+   * @see https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.3
+   */
+  exclusiveMaximum?: boolean;
+  /**
+   * Representing an inclusive lower limit for a numeric instance.
+   * This keyword validates only if the instance is greater than or exactly equal to "minimum".
+   * @see https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.4
+   */
+  minimum?: number;
+  /**
+   * Representing an exclusive lower limit for a numeric instance.
+   * This keyword validates only if the instance is strictly greater than (not equal to) to "exclusiveMinimum".
+   * @see https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.5
+   */
+  exclusiveMinimum?: boolean;
+  /**
+   * Must be a non-negative integer.
+   * A string instance is valid against this keyword if its length is less than, or equal to, the value of this keyword.
+   * @see https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.6
+   */
+  maxLength?: number;
+  /**
+   * Must be a non-negative integer.
+   * A string instance is valid against this keyword if its length is greater than, or equal to, the value of this keyword.
+   * Omitting this keyword has the same behavior as a value of 0.
+   * @see https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.7
+   */
+  minLength?: number;
+  /**
+   * Should be a valid regular expression, according to the ECMA 262 regular expression dialect.
+   * @see https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.8
+   */
+  pattern?: string;
+  /**
+   * Must be a non-negative integer.
+   * An array instance is valid against "maxItems" if its size is less than, or equal to, the value of this keyword.
+   * @see https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.11
+   */
+  maxItems?: number;
+  /**
+   * Must be a non-negative integer.
+   * An array instance is valid against "maxItems" if its size is greater than, or equal to, the value of this keyword.
+   * Omitting this keyword has the same behavior as a value of 0.
+   * @see https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.12
+   */
+  minItems?: number;
+  /**
+   * If this keyword has boolean value false, the instance validates successfully.
+   * If it has boolean value true, the instance validates successfully if all of its elements are unique.
+   * Omitting this keyword has the same behavior as a value of false.
+   * @see https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.13
+   */
+  uniqueItems?: boolean;
+  /**
+   * Must be a non-negative integer.
+   * An object instance is valid against "maxProperties" if its number of properties is less than, or equal to, the value of this keyword.
+   * @see https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.15
+   */
+  maxProperties?: number;
+  /**
+   * Must be a non-negative integer.
+   * An object instance is valid against "maxProperties" if its number of properties is greater than,
+   * or equal to, the value of this keyword.
+   * Omitting this keyword has the same behavior as a value of 0.
+   * @see https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.16
+   */
+  minProperties?: number;
+  /**
+   * This provides an enumeration of all possible values that are valid
+   * for the instance property. This MUST be an array, and each item in
+   * the array represents a possible value for the instance value. If
+   * this attribute is defined, the instance value MUST be one of the
+   * values in the array in order for the schema to be valid.
+   *
+   * @see https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.23
+   */
+  enum?: any[];
+  /**
+   * This attribute is a string that provides a full description of the of purpose the instance property.
+   *
+   * @see https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-7.2
+   */
+  description?: string;
+  /**
+   * This keyword can be used to supply a default JSON value associated with a particular schema.
+   * It is RECOMMENDED that a default value be valid against the associated schema.
+   * @see https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-7.3
+   */
+  default?: any;
+  /**
+   * @see https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-8
+   */
+  format?: string;
+  /**
+   * A single type, or a union of simple types
+   * @see https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.25
+   */
+  type?: OpenSpecTypes;
+}
+
+export interface OpenSpecJsonSchema<Schema = any> extends OpenSpecBaseJsonSchema {
+  /**
+   * Required if type is "array". Describes the type of items in the array.
+   */
+  items?: Schema | OpenSpecRef;
+  /**
+   * A free-form property to include an example of an instance for this schema.
+   */
+  required?: string[];
+  /**
+   * Value can be boolean or object. Inline or referenced schema MUST be of a Schema Object and not a standard JSON Schema.
+   */
+  additionalProperties?: Schema | boolean;
+  /**
+   * Property definitions MUST be a Schema Object and not a standard JSON Schema (inline or referenced).
+   */
+  properties?: OpenSpecHash<Schema>;
+  /**
+   * 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.
+   */
+  allOf?: (Schema | OpenSpecRef)[];
+  /**
+   * Additional external documentation for this schema.
+   */
+  example?: any;
+}

package/src/common/OpenSpecPath.ts

@@ -0,0 +1,10 @@
+export interface OpenSpecPath<Operation> {
+  $ref?: string;
+  get?: Operation;
+  put?: Operation;
+  post?: Operation;
+  delete?: Operation;
+  options?: Operation;
+  head?: Operation;
+  patch?: Operation;
+}

package/src/common/OpenSpecRef.ts

@@ -0,0 +1,3 @@
+export interface OpenSpecRef {
+  $ref: string;
+}

package/src/common/OpenSpecSecurity.ts

@@ -0,0 +1,3 @@
+import {OpenSpecHash} from "./OpenSpecHash.js";
+
+export type OpenSpecSecurity = OpenSpecHash<string[]>[];

package/src/common/OpenSpecTag.ts

@@ -0,0 +1,7 @@
+import {OpenSpecExternalDocs} from "./OpenSpecExternalDocs.js";
+
+export interface OpenSpecTag {
+  name: string;
+  description?: string;
+  externalDocs?: OpenSpecExternalDocs;
+}

package/src/common/OpenSpecTypes.ts

@@ -0,0 +1 @@
+export type OpenSpecTypes = "string" | "number" | "integer" | "boolean" | "array" | "object" | "file";

package/src/common/OpenSpecVersions.ts

@@ -0,0 +1,3 @@
+export type OS2Versions = "2.0";
+export type OS3Versions = "3.0.1" | "3.0.2" | "3.0.3" | "3.1.0";
+export type OpenSpecVersions = OS2Versions | OS3Versions;

package/src/common/OpenSpecXML.ts

@@ -0,0 +1,22 @@
+export interface OpenSpecXML {
+  /**
+   * Replaces the name of the element/attribute used for the described schema property. When defined within items, it will affect the name of the individual XML elements within the list. When defined alongside type being array (outside the items), it will affect the wrapping element and only if wrapped is true. If wrapped is false, it will be ignored.
+   */
+  name?: string;
+  /**
+   * The URI of the namespace definition. Value MUST be in the form of an absolute URI.
+   */
+  namespace?: string;
+  /**
+   * The prefix to be used for the [name](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md#xmlName).
+   */
+  prefix?: string;
+  /**
+   * Declares whether the property definition translates to an attribute instead of an element. Default value is false.
+   */
+  attribute?: boolean;
+  /**
+   * MAY be used only for an array definition. Signifies whether the array is wrapped (for example, <books><book/><book/></books>) or unwrapped (<book/><book/>). Default value is false. The definition takes effect only when defined alongside type being array (outside the items).
+   */
+  wrapped?: boolean;
+}

package/src/index.ts

@@ -0,0 +1,39 @@
+/**
+ * @file Automatically generated by @tsed/barrels.
+ */
+export * from "./common/OpenSpecExternalDocs.js";
+export * from "./common/OpenSpecHash.js";
+export * from "./common/OpenSpecInfo.js";
+export * from "./common/OpenSpecJsonSchema.js";
+export * from "./common/OpenSpecPath.js";
+export * from "./common/OpenSpecRef.js";
+export * from "./common/OpenSpecSecurity.js";
+export * from "./common/OpenSpecTag.js";
+export * from "./common/OpenSpecTypes.js";
+export * from "./common/OpenSpecVersions.js";
+export * from "./common/OpenSpecXML.js";
+export * from "./openspec2/OpenSpec2.js";
+export * from "./openspec2/OS2Header.js";
+export * from "./openspec2/OS2Operation.js";
+export * from "./openspec2/OS2Parameter.js";
+export * from "./openspec2/OS2Paths.js";
+export * from "./openspec2/OS2Response.js";
+export * from "./openspec2/OS2Schema.js";
+export * from "./openspec2/OS2Security.js";
+export * from "./openspec3/OpenSpec3.js";
+export * from "./openspec3/OS3Callbacks.js";
+export * from "./openspec3/OS3Components.js";
+export * from "./openspec3/OS3Encoding.js";
+export * from "./openspec3/OS3Example.js";
+export * from "./openspec3/OS3Flows.js";
+export * from "./openspec3/OS3Header.js";
+export * from "./openspec3/OS3Link.js";
+export * from "./openspec3/OS3MediaType.js";
+export * from "./openspec3/OS3Operation.js";
+export * from "./openspec3/OS3Parameter.js";
+export * from "./openspec3/OS3Paths.js";
+export * from "./openspec3/OS3RequestBody.js";
+export * from "./openspec3/OS3Response.js";
+export * from "./openspec3/OS3Schema.js";
+export * from "./openspec3/OS3Security.js";
+export * from "./openspec3/OS3Server.js";

package/src/openspec2/OS2Header.ts

@@ -0,0 +1,8 @@
+import {OS2BaseSchema} from "./OS2Schema.js";
+
+export interface OS2Header extends OS2BaseSchema {
+  /**
+   * The type of the object. The value MUST be one of `string`, `number`, `integer`, `boolean`, or `array`.
+   */
+  type: "string" | "number" | "integer" | "boolean" | "array";
+}

package/src/openspec2/OS2Operation.ts

@@ -0,0 +1,65 @@
+import {OpenSpecExternalDocs} from "../common/OpenSpecExternalDocs.js";
+import {OpenSpecHash} from "../common/OpenSpecHash.js";
+import {OpenSpecRef} from "../common/OpenSpecRef.js";
+import {OpenSpecSecurity} from "../common/OpenSpecSecurity.js";
+import {OS2Parameter} from "./OS2Parameter.js";
+import {OS2Response} from "./OS2Response.js";
+
+export interface OS2Operation {
+  /**
+   * 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[];
+  /**
+   * A short summary of what the operation does. For maximum readability in the swagger-ui, this field SHOULD be less than 120 characters.
+   */
+  summary?: string;
+  /**
+   * A verbose explanation of the operation behavior. GFM syntax can be used for rich text representation.
+   */
+  description?: string;
+  /**
+   * Additional external documentation for this operation.
+   */
+  externalDocs?: OpenSpecExternalDocs;
+  /**
+   * 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 list of MIME types the operation can consume. This overrides the consumes definition at the Swagger Object. An empty value MAY be used to clear the global definition. Value MUST be as described under [Mime Types](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#mimeTypes).
+   */
+  consumes?: string[];
+  /**
+   * A list of MIME types the operation can produce. This overrides the produces definition at the Swagger Object. An empty value MAY be used to clear the global definition. Value MUST be as described under [Mime Types](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#mimeTypes).
+   */
+  produces?: string[];
+  /**
+   * 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/2.0.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/2.0.md#parameterName) and (location)[https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#parameterIn].
+   * The list can use the [Reference Object](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#referenceObject) to link to parameters that are defined at the [Swagger Object's parameters](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#swaggerParameters).
+   * There can be one "body" parameter at most.
+   */
+  parameters?: (OS2Parameter | OpenSpecRef)[];
+  /**
+   * The list of possible responses as they are returned from executing this operation.
+   */
+  responses: OpenSpecHash<OS2Response | OpenSpecRef>;
+  /**
+   * The transfer protocol of the API. Values MUST be from the list: `http`, `https`, `ws`, `wss`. If the schemes is not included, the default scheme to be used is the one used to access the Swagger definition itself.
+   */
+  schemes?: string[];
+  /**
+   * Declares this operation to be deprecated. Usage of the declared operation should be refrained. Default value is false.
+   */
+  deprecated?: boolean;
+  /**
+   * A declaration of which security schemes are applied for this operation.
+   * The list of values describes alternative security schemes that can be used (that is, there is a logical OR between the security requirements).
+   * This definition overrides any declared top-level [security](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#swaggerSecurity).
+   * To remove a top-level security declaration, an empty array can be used.
+   */
+  security?: OpenSpecSecurity;
+}

package/src/openspec2/OS2Parameter.ts

@@ -0,0 +1,65 @@
+import {OpenSpecTypes} from "../common/OpenSpecTypes.js";
+import {OS2BaseSchema, OS2Schema} from "./OS2Schema.js";
+
+export type OS2BaseParameter = {
+  name: string;
+  in: "body" | "query" | "path" | "header" | "formData";
+  required?: boolean;
+  description?: string;
+};
+
+export type OS2BodyParameter = OS2BaseParameter & {
+  in: "body";
+  schema?: OS2Schema;
+};
+
+export type OS2GenericFormat = {
+  type?: OpenSpecTypes;
+  format?: string;
+};
+
+export type OS2IntegerFormat = {
+  type: "integer";
+  format?: "int32" | "int64";
+};
+
+export type OS2NumberFormat = {
+  type: "number";
+  format?: "float" | "double";
+};
+
+export type OS2StringFormat = {
+  type: "string";
+  format?: "" | "byte" | "binary" | "date" | "date-time" | "password";
+};
+
+export type OS2SchemaFormatConstraints = OS2GenericFormat | OS2IntegerFormat | OS2NumberFormat | OS2StringFormat;
+export type OS2BaseFormatContrainedParameter = OS2BaseParameter & OS2SchemaFormatConstraints;
+export type ParameterCollectionFormat = "csv" | "ssv" | "tsv" | "pipes" | "multi";
+export type OS2QueryParameter = OS2BaseFormatContrainedParameter &
+  OS2BaseSchema & {
+    in: "query";
+    allowEmptyValue?: boolean;
+    collectionFormat?: ParameterCollectionFormat;
+  };
+
+export type OS2PathParameter = OS2BaseFormatContrainedParameter &
+  OS2BaseSchema & {
+    in: "path";
+    required: true;
+  };
+
+export type OS2HeaderParameter = OS2BaseFormatContrainedParameter &
+  OS2BaseSchema & {
+    in: "header";
+  };
+
+export type OS2FormDataParameter = OS2BaseFormatContrainedParameter &
+  OS2BaseSchema & {
+    in: "formData";
+    type: OpenSpecTypes;
+    allowEmptyValue?: boolean;
+    collectionFormat?: ParameterCollectionFormat;
+  };
+
+export type OS2Parameter = OS2BodyParameter | OS2FormDataParameter | OS2QueryParameter | OS2PathParameter | OS2HeaderParameter;

package/src/openspec2/OS2Paths.ts

@@ -0,0 +1,8 @@
+import {OpenSpecPath} from "../common/OpenSpecPath.js";
+import {OpenSpecRef} from "../common/OpenSpecRef.js";
+import {OS2Operation} from "./OS2Operation.js";
+import {OS2Parameter} from "./OS2Parameter.js";
+
+export interface OS2Paths extends OpenSpecPath<OS2Operation> {
+  parameters?: (OS2Parameter | OpenSpecRef)[];
+}

package/src/openspec2/OS2Response.ts

@@ -0,0 +1,22 @@
+import {OpenSpecHash} from "../common/OpenSpecHash.js";
+import {OS2Header} from "./OS2Header.js";
+import {OS2Schema} from "./OS2Schema.js";
+
+export interface OS2Response {
+  /**
+   * A short description of the response. GFM syntax can be used for rich text representation.
+   */
+  description: string;
+  /**
+   * A definition of the response structure. It can be a primitive, an array or an object. If this field does not exist, it means no content is returned as part of the response. As an extension to the Schema Object, its root type value may also be "file". This SHOULD be accompanied by a relevant produces mime-type.
+   */
+  schema?: OS2Schema;
+  /**
+   * A list of headers that are sent with the response.
+   */
+  headers?: OpenSpecHash<OS2Header>;
+  /**
+   * An example of the response message.
+   */
+  examples?: OpenSpecHash<{}>;
+}

package/src/openspec2/OS2Schema.ts

@@ -0,0 +1,39 @@
+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 OS2XML {
+  name?: string;
+  namespace?: string;
+  prefix?: string;
+  attribute?: boolean;
+  wrapped?: boolean;
+}
+
+export interface OS2BaseSchema extends OpenSpecBaseJsonSchema {
+  /**
+   * Required if type is "array". Describes the type of items in the array.
+   */
+  items?: OS2Schema | OpenSpecRef;
+}
+
+export interface OS2Schema extends OpenSpecJsonSchema<OS2Schema> {
+  /**
+   * 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;
+  /**
+   * 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/openspec2/OS2Security.ts

@@ -0,0 +1,58 @@
+import {OpenSpecHash} from "../common/OpenSpecHash.js";
+
+export interface OS2SecurityBase {
+  /**
+   * The type of the security scheme
+   */
+  type: "basic" | "apiKey" | "oauth2";
+  /**
+   *
+   */
+  description?: string;
+}
+
+export interface OS2SecurityBasic extends OS2SecurityBase {
+  type: "basic";
+}
+
+export interface OS2SecurityApiKey extends OS2SecurityBase {
+  type: "apiKey";
+  name: string;
+  in: "query" | "header";
+}
+
+export interface OS2SecurityOAuth extends OS2SecurityBase {
+  type: "oauth2";
+  flow: "accessCode" | "application" | "implicit" | "password";
+  /**
+   * The available scopes for the OAuth2 security scheme.
+   */
+  scopes: OpenSpecHash<string>;
+}
+
+export interface OS2FlowImplicit extends OS2SecurityOAuth {
+  type: "oauth2";
+  flow: "implicit";
+  authorizationUrl: string;
+}
+
+export interface OS2FlowPassword extends OS2SecurityOAuth {
+  type: "oauth2";
+  flow: "password";
+  tokenUrl: string;
+}
+
+export interface OS2FlowApplication extends OS2SecurityOAuth {
+  type: "oauth2";
+  flow: "application";
+  tokenUrl: string;
+}
+
+export interface OS2FlowAccessCode extends OS2SecurityOAuth {
+  type: "oauth2";
+  flow: "accessCode";
+  tokenUrl: string;
+  authorizationUrl: string;
+}
+
+export type OS2Security = OS2SecurityBasic | OS2FlowAccessCode | OS2FlowApplication | OS2FlowImplicit | OS2FlowPassword | OS2SecurityApiKey;