@tsed/openspec 8.0.1 → 8.0.2

package/src/openspec3/OS3Server.ts

@@ -0,0 +1,31 @@
+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

@@ -0,0 +1,44 @@
+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;
+}