jsdevel

openapi-types

    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 Modify<T, R> = Omit<T, keyof R> & R;

    type PathsWebhooksComponents<T extends {} = {}> = {

        webhooks: Record<string, PathItemObject | ReferenceObject>;

    export type Document<T extends {} = {}> = Modify<Omit<OpenAPIV3.Document<T>, 'paths' | 'components'>, {

    } & ((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, {

    export type ContactObject = OpenAPIV3.ContactObject;

    export type LicenseObject = Modify<OpenAPIV3.LicenseObject, {

    export type ServerObject = Modify<OpenAPIV3.ServerObject, {

        variables?: Record<string, ServerVariableObject>;

    export type ServerVariableObject = Modify<OpenAPIV3.ServerVariableObject, {

    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>, {

        parameters?: (ReferenceObject | ParameterObject)[];

        [method in HttpMethods]?: OperationObject<T>;

    export type OperationObject<T extends {} = {}> = Modify<OpenAPIV3.OperationObject<T>, {

        requestBody?: ReferenceObject | RequestBodyObject;

        callbacks?: Record<string, ReferenceObject | CallbackObject>;

    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 {

        items: ReferenceObject | SchemaObject;

    export interface NonArraySchemaObject extends BaseSchemaObject {

    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;

        additionalProperties?: boolean | ReferenceObject | SchemaObject;

            [name: string]: ReferenceObject | SchemaObject;

        allOf?: (ReferenceObject | SchemaObject)[];

        oneOf?: (ReferenceObject | SchemaObject)[];

        anyOf?: (ReferenceObject | SchemaObject)[];

        not?: ReferenceObject | SchemaObject;

        discriminator?: DiscriminatorObject;

        externalDocs?: ExternalDocumentationObject;

    export type DiscriminatorObject = OpenAPIV3.DiscriminatorObject;

    export type XMLObject = OpenAPIV3.XMLObject;

    export type ReferenceObject = Modify<OpenAPIV3.ReferenceObject, {

    interface HeaderObject extends ItemsObject {

    type OperationObject<T extends {} = {}> = {

        security?: SecurityRequirementObject[];

        [index: string]: Response | undefined;

    type Parameters = (ReferenceObject | Parameter)[];

    type Parameter = InBodyParameterObject | GeneralParameterObject;

    interface InBodyParameterObject extends ParameterObject {

    interface GeneralParameterObject extends ParameterObject, ItemsObject {

    type PathItemObject<T extends {} = {}> = {

    interface PathsObject<T extends {} = {}> {

        [index: string]: PathItemObject<T>;

    interface ParametersDefinitionsObject {

        [index: string]: ParameterObject;

    interface SchemaObject extends IJsonSchema {

        items?: ItemsObject | ReferenceObject;

            [name: string]: SchemaObject;

    interface ExternalDocumentationObject {

  "description": "Types for OpenAPI documents.",

    "url": "https://github.com/kogosoftwarellc/open-api/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+label%3Aopenapi-types"

  "repository": "https://github.com/kogosoftwarellc/open-api/tree/master/packages/openapi-types",

  "homepage": "https://github.com/kogosoftwarellc/open-api/tree/master/packages/openapi-types#readme",

  "gitHead": "2256840df589723c2fadbde293317b1eb95c9ef9"

  "gitHead": "6d41b16b049bdb2c35bb62e9b9c4f2109313c827"

# openapi-types [![NPM version][npm-image]][npm-url] [![Downloads][downloads-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Coveralls Status][coveralls-image]][coveralls-url] [![Gitter chat][gitter-image]][gitter-url]

# openapi-types [![NPM version][npm-image]][npm-url] [![Downloads][downloads-image]][npm-url] [![Coveralls Status][coveralls-image]][coveralls-url] [![Gitter chat][gitter-image]][gitter-url]

import { OpenAPIV2, OpenAPIV3, OpenAPIV3_1 } from "openapi-types";

function processV2(doc: OpenAPIV2.Document) {}

function processV3(doc: OpenAPIV3.Document) {}

function processV3_1(doc: OpenAPIV3_1.Document) {}

Permission is hereby granted, free of charge, to any person obtaining a copy

of this software and associated documentation files (the "Software"), to deal

in the Software without restriction, including without limitation the rights

to use, copy, modify, merge, publish, distribute, sublicense, and/or sell

copies of the Software, and to permit persons to whom the Software is

furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in

all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN

[downloads-image]: http://img.shields.io/npm/dm/openapi-types.svg

[npm-url]: https://npmjs.org/package/openapi-types

[npm-image]: http://img.shields.io/npm/v/openapi-types.svg

[travis-url]: https://travis-ci.org/kogosoftwarellc/open-api

[travis-image]: https://api.travis-ci.org/kogosoftwarellc/open-api.svg?branch=master

[coveralls-url]: https://coveralls.io/r/kogosoftwarellc/open-api

[coveralls-image]: https://coveralls.io/repos/github/kogosoftwarellc/open-api/badge.svg?branch=master

[gitter-url]: https://gitter.im/kogosoftwarellc/open-api

[gitter-image]: https://badges.gitter.im/kogosoftwarellc/open-api.png

		@@ -561,2 +561,3 @@ export declare namespace OpenAPI {
		interface HeaderObject extends ItemsObject {
		description?: string;
		}
		@@ -563,0 +564,0 @@ interface ExampleObject {

		{
		"name": "openapi-types",
		"version": "12.1.0",
		"version": "12.1.1",
		"description": "Types for OpenAPI documents.",
		@@ -24,3 +24,3 @@ "main": "./dist/index.js",
		"license": "MIT",
		"gitHead": "2256840df589723c2fadbde293317b1eb95c9ef9"
		"gitHead": "6d41b16b049bdb2c35bb62e9b9c4f2109313c827"
		}

Improved metrics

Worsened metrics

		@@ -1,2 +0,2 @@
		# openapi-types [![NPM version][npm-image]][npm-url] [![Downloads][downloads-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Coveralls Status][coveralls-image]][coveralls-url] [![Gitter chat][gitter-image]][gitter-url]
		# openapi-types [![NPM version][npm-image]][npm-url] [![Downloads][downloads-image]][npm-url] [![Coveralls Status][coveralls-image]][coveralls-url] [![Gitter chat][gitter-image]][gitter-url]
		> Types for OpenAPI documents.
		@@ -45,5 +45,2 @@

		[travis-url]: https://travis-ci.org/kogosoftwarellc/open-api
		[travis-image]: https://api.travis-ci.org/kogosoftwarellc/open-api.svg?branch=master

		[coveralls-url]: https://coveralls.io/r/kogosoftwarellc/open-api
		@@ -50,0 +47,0 @@ [coveralls-image]: https://coveralls.io/repos/github/kogosoftwarellc/open-api/badge.svg?branch=master