Détail du package

openapi-types

kogosoftwarellc16.3mMIT12.1.3

Types for OpenAPI documents.

openapi, swagger, types, typescript

readme

openapi-types NPM version Downloads Coveralls Status

Types for OpenAPI documents.

Usage

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) {}

LICENSE

The MIT License (MIT)

Copyright (c) 2018 Kogo Software LLC

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
THE SOFTWARE.

changelog

openapi-types Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

1.4.0 - 2021-01-05

Added

  • Added an index signature to OperationObject to allow access to extensions.

Fixed

  • Added undefined to the index signature for PathsObject to prevent unsafe null access when strictNullChecks is enabled.

1.3.5 - 2019-05-13

Fixed

  • Amended missing usage of PathsObject in OpenAPIV3.Document interface.

1.3.4 - 2019-01-31

Fixed

  • OpenAPIV3: relax security requirement object types (#327)

1.3.3 - 2019-01-22

Fixed

  • Allowing to set a property of BaseSchemaObject as a reference to another SchemaObject (#312)

1.3.2 - 2018-10-17

Added

  • Added Operation to OpenAPI namespace.

1.3.1 - 2018-10-03

Fixed

  • Updating .npmignore to publish dist

1.3.0 - 2018-10-03

Added

  • OpenAPI.Parameter - Represents a parameter across all OpenAPI versions that have the notion of a parameter.

1.2.0 - 2018-09-29

Added

  • OpenAPI.Parameters - Represents parameters across all OpenAPI versions that have the notion of parameters.
  • exporting OpenAPIV2.Parameters and OpenAPIV2.Parameter.