Security News
tea.xyz Spam Plagues npm and RubyGems Package Registries
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
openapi-types
Advanced tools
Package description
The openapi-types npm package provides TypeScript definitions for OpenAPI Specification (OAS). It allows developers to use strong typing when working with OpenAPI documents in TypeScript projects, ensuring that the structure of the API documentation adheres to the OpenAPI Specification standards.
OpenAPI Document Types
Provides TypeScript interfaces for OpenAPI 3.0 documents, allowing developers to define API structure in a type-safe manner.
{"import { OpenAPIV3 } from 'openapi-types';
const document: OpenAPIV3.Document = {
openapi: '3.0.0',
info: {
title: 'Sample API',
version: '1.0.0'
},
paths: {}
};"}
OpenAPI Path Item Types
Allows for the definition of individual path items and their operations, ensuring that they conform to the OpenAPI Specification.
{"import { OpenAPIV3 } from 'openapi-types';
const pathItem: OpenAPIV3.PathItemObject = {
get: {
responses: {
'200': {
description: 'Success',
content: {
'application/json': {
schema: {
type: 'array',
items: {
type: 'string'
}
}
}
}
}
}
}
};"}
OpenAPI Components Types
Enables the definition of reusable components such as schemas, responses, parameters, and more, with type safety.
{"import { OpenAPIV3 } from 'openapi-types';
const components: OpenAPIV3.ComponentsObject = {
schemas: {
'Product': {
type: 'object',
properties: {
id: {
type: 'integer',
format: 'int64'
},
name: {
type: 'string'
}
}
}
}
};"}
This package allows you to integrate Swagger using JSDoc comments directly in your code. Unlike openapi-types, which provides TypeScript definitions, swagger-jsdoc is more about generating OpenAPI documentation from code comments.
Used to serve auto-generated swagger-ui generated API docs from express, based on a swagger.json file. It is different from openapi-types as it focuses on the visualization and interaction with the API documentation rather than providing type definitions.
A package that validates and dereferences Swagger and OpenAPI files. While openapi-types provides type definitions, swagger-parser is more about ensuring the validity and resolving references in OpenAPI documents.
Readme
Types for OpenAPI documents.
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) {}
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.
FAQs
Types for OpenAPI documents.
The npm package openapi-types receives a total of 2,338,370 weekly downloads. As such, openapi-types popularity was classified as popular.
We found that openapi-types demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.