openapi-types - npm Package Compare versions

Comparing version 9.1.0 to 9.2.0

dist/index.d.ts

 export declare namespace OpenAPI {
-    type Document<T extends {} = {}> = OpenAPIV2.Document<T> | OpenAPIV3.Document<T>;
-    type Operation<T extends {} = {}> = OpenAPIV2.OperationObject<T> | OpenAPIV3.OperationObject<T>;
-    type Parameter = OpenAPIV3.ReferenceObject | OpenAPIV3.ParameterObject | OpenAPIV2.ReferenceObject | OpenAPIV2.Parameter;
-    type Parameters = (OpenAPIV3.ReferenceObject | OpenAPIV3.ParameterObject)[] | (OpenAPIV2.ReferenceObject | OpenAPIV2.Parameter)[];
+    type Document<T extends {} = {}> = OpenAPIV2.Document<T> | OpenAPIV3.Document<T> | OpenAPIV3_1.Document<T>;
+    type Operation<T extends {} = {}> = OpenAPIV2.OperationObject<T> | OpenAPIV3.OperationObject<T> | OpenAPIV3_1.OperationObject<T>;
+    type Parameter = OpenAPIV3_1.ReferenceObject | OpenAPIV3_1.ParameterObject | OpenAPIV3.ReferenceObject | OpenAPIV3.ParameterObject | OpenAPIV2.ReferenceObject | OpenAPIV2.Parameter;
+    type Parameters = (OpenAPIV3_1.ReferenceObject | OpenAPIV3_1.ParameterObject)[] | (OpenAPIV3.ReferenceObject | OpenAPIV3.ParameterObject)[] | (OpenAPIV2.ReferenceObject | OpenAPIV2.Parameter)[];
     interface Request {
@@ -13,2 +13,140 @@ body?: any;
 }
+export declare namespace OpenAPIV3_1 {
+    type Modify<T, R> = Omit<T, keyof R> & R;
+    type PathsWebhooksComponents<T> = {
+        paths: PathsObject<T>;
+        webhooks: Record<string, PathItemObject | ReferenceObject>;
+        components: ComponentsObject;
+    };
+    export type Document<T extends {} = {}> = Modify<Omit<OpenAPIV3.Document<T>, 'paths' | 'components'>, {
+        info: InfoObject;
+        jsonSchemaDialect?: string;
+        servers?: ServerObject[];
+    } & ((Pick<PathsWebhooksComponents<T>, 'paths'> & Omit<Partial<PathsWebhooksComponents<T>>, 'paths'>) | (Pick<PathsWebhooksComponents<T>, 'webhooks'> & Omit<Partial<PathsWebhooksComponents<T>>, 'webhooks'>) | (Pick<PathsWebhooksComponents<T>, 'components'> & Omit<Partial<PathsWebhooksComponents<T>>, 'components'>))>;
+    export type InfoObject = Modify<OpenAPIV3.InfoObject, {
+        summary?: string;
+        license?: LicenseObject;
+    }>;
+    export type ContactObject = OpenAPIV3.ContactObject;
+    export type LicenseObject = Modify<OpenAPIV3.LicenseObject, {
+        identifier?: string;
+    }>;
+    export type ServerObject = Modify<OpenAPIV3.ServerObject, {
+        url: string;
+        description?: string;
+        variables?: Record<string, ServerVariableObject>;
+    }>;
+    export type ServerVariableObject = Modify<OpenAPIV3.ServerVariableObject, {
+        enum?: [string, ...string[]];
+    }>;
+    export type PathsObject<T extends {} = {}, P extends {} = {}> = Record<string, (PathItemObject<T> & P) | undefined>;
+    export type HttpMethods = OpenAPIV3.HttpMethods;
+    export type PathItemObject<T extends {} = {}> = Modify<OpenAPIV3.PathItemObject<T>, {
+        servers?: ServerObject[];
+        parameters?: (ReferenceObject | ParameterObject)[];
+    }> & {
+        [method in HttpMethods]?: OperationObject<T>;
+    };
+    export type OperationObject<T extends {} = {}> = Modify<OpenAPIV3.OperationObject<T>, {
+        parameters?: (ReferenceObject | ParameterObject)[];
+        requestBody?: ReferenceObject | RequestBodyObject;
+        responses?: ResponsesObject;
+        callbacks?: Record<string, ReferenceObject | CallbackObject>;
+        servers?: ServerObject[];
+    }> & T;
+    export type ExternalDocumentationObject = OpenAPIV3.ExternalDocumentationObject;
+    export type ParameterObject = OpenAPIV3.ParameterObject;
+    export type HeaderObject = OpenAPIV3.HeaderObject;
+    export type ParameterBaseObject = OpenAPIV3.ParameterBaseObject;
+    export type NonArraySchemaObjectType = OpenAPIV3.NonArraySchemaObjectType | 'null';
+    export type ArraySchemaObjectType = OpenAPIV3.ArraySchemaObjectType;
+    /**
+     * There is no way to tell typescript to require items when type is either 'array' or array containing 'array' type
+     * 'items' will be always visible as optional
+     * Casting schema object to ArraySchemaObject or NonArraySchemaObject will work fine
+     */
+    export type SchemaObject = ArraySchemaObject | NonArraySchemaObject | MixedSchemaObject;
+    export interface ArraySchemaObject extends BaseSchemaObject {
+        type: ArraySchemaObjectType;
+        items: ReferenceObject | SchemaObject;
+    }
+    export interface NonArraySchemaObject extends BaseSchemaObject {
+        type?: NonArraySchemaObjectType;
+    }
+    interface MixedSchemaObject extends BaseSchemaObject {
+        type?: (ArraySchemaObjectType | NonArraySchemaObjectType)[];
+        items?: ReferenceObject | SchemaObject;
+    }
+    export type BaseSchemaObject = Modify<Omit<OpenAPIV3.BaseSchemaObject, 'nullable'>, {
+        examples?: OpenAPIV3.BaseSchemaObject['example'][];
+        exclusiveMinimum?: boolean | number;
+        exclusiveMaximum?: boolean | number;
+        contentMediaType?: string;
+        $schema?: string;
+        additionalProperties?: boolean | ReferenceObject | SchemaObject;
+        properties?: {
+            [name: string]: ReferenceObject | SchemaObject;
+        };
+        allOf?: (ReferenceObject | SchemaObject)[];
+        oneOf?: (ReferenceObject | SchemaObject)[];
+        anyOf?: (ReferenceObject | SchemaObject)[];
+        not?: ReferenceObject | SchemaObject;
+        discriminator?: DiscriminatorObject;
+        externalDocs?: ExternalDocumentationObject;
+        xml?: XMLObject;
+    }>;
+    export type DiscriminatorObject = OpenAPIV3.DiscriminatorObject;
+    export type XMLObject = OpenAPIV3.XMLObject;
+    export type ReferenceObject = Modify<OpenAPIV3.ReferenceObject, {
+        summary?: string;
+        description?: string;
+    }>;
+    export type ExampleObject = OpenAPIV3.ExampleObject;
+    export type MediaTypeObject = Modify<OpenAPIV3.MediaTypeObject, {
+        schema?: SchemaObject;
+        examples?: Record<string, ReferenceObject | ExampleObject>;
+    }>;
+    export type EncodingObject = OpenAPIV3.EncodingObject;
+    export type RequestBodyObject = Modify<OpenAPIV3.RequestBodyObject, {
+        content: {
+            [media: string]: MediaTypeObject;
+        };
+    }>;
+    export type ResponsesObject = Record<string, ReferenceObject | ResponseObject>;
+    export type ResponseObject = Modify<OpenAPIV3.ResponseObject, {
+        headers?: {
+            [header: string]: ReferenceObject | HeaderObject;
+        };
+        content?: {
+            [media: string]: MediaTypeObject;
+        };
+        links?: {
+            [link: string]: ReferenceObject | LinkObject;
+        };
+    }>;
+    export type LinkObject = Modify<OpenAPIV3.LinkObject, {
+        server?: ServerObject;
+    }>;
+    export type CallbackObject = Record<string, PathItemObject | ReferenceObject>;
+    export type SecurityRequirementObject = OpenAPIV3.SecurityRequirementObject;
+    export type ComponentsObject = Modify<OpenAPIV3.ComponentsObject, {
+        schemas?: Record<string, SchemaObject>;
+        responses?: Record<string, ReferenceObject | ResponseObject>;
+        parameters?: Record<string, ReferenceObject | ParameterObject>;
+        examples?: Record<string, ReferenceObject | ExampleObject>;
+        requestBodies?: Record<string, ReferenceObject | RequestBodyObject>;
+        headers?: Record<string, ReferenceObject | HeaderObject>;
+        securitySchemes?: Record<string, ReferenceObject | SecuritySchemeObject>;
+        links?: Record<string, ReferenceObject | LinkObject>;
+        callbacks?: Record<string, ReferenceObject | CallbackObject>;
+        pathItems?: Record<string, ReferenceObject | PathItemObject>;
+    }>;
+    export type SecuritySchemeObject = OpenAPIV3.SecuritySchemeObject;
+    export type HttpSecurityScheme = OpenAPIV3.HttpSecurityScheme;
+    export type ApiKeySecurityScheme = OpenAPIV3.ApiKeySecurityScheme;
+    export type OAuth2SecurityScheme = OpenAPIV3.OAuth2SecurityScheme;
+    export type OpenIdSecurityScheme = OpenAPIV3.OpenIdSecurityScheme;
+    export type TagObject = OpenAPIV3.TagObject;
+    export {};
+}
 export declare namespace OpenAPIV3 {
@@ -56,4 +194,4 @@ interface Document<T extends {} = {}> {
     }
-    interface PathsObject<T extends {} = {}> {
-        [pattern: string]: PathItemObject<T> | undefined;
+    interface PathsObject<T extends {} = {}, P extends {} = {}> {
+        [pattern: string]: (PathItemObject<T> & P) | undefined;
     }
@@ -87,3 +225,3 @@ enum HttpMethods {
         requestBody?: ReferenceObject | RequestBodyObject;
-        responses?: ResponsesObject;
+        responses: ResponsesObject;
         callbacks?: {
@@ -90,0 +228,0 @@ [callback: string]: ReferenceObject | CallbackObject;

package.json

 {
   "name": "openapi-types",
-  "version": "9.1.0",
+  "version": "9.2.0",
   "description": "Types for OpenAPI documents.",
@@ -24,3 +24,3 @@ "main": "./dist/index.js",
   "license": "MIT",
-  "gitHead": "1b56b57bc6417f36aa8a6af1b83dcb9720113070"
+  "gitHead": "24d87763c621f0886d02dbe96b20364055c46125"
 }

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

32829

increased by27.15%

Lines of code

770

increased by22.03%

No dependency changes