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.
@swagger-api/apidom-parser-adapter-openapi-yaml-3-1
Advanced tools
Changelog
0.98.0 (2024-03-21)
Readme
@swagger-api/apidom-parser-adapter-openapi-yaml-3-1
is a parser adapter for the OpenAPI 3.1.0 specification in YAML format.
Under the hood this adapter uses apidom-parser-adapter-yaml-1-2
to parse a source string into generic ApiDOM in base ApiDOM namespace
which is then refracted with OpenAPI 3.1.0 Refractors.
After prerequisites for installing this package are satisfied, you can install it via npm CLI by running the following command:
$ npm install @swagger-api/apidom-parser-adapter-openapi-yaml-3-1
This parser adapter is fully compatible with parser adapter interface required by @swagger-api/apidom-parser and implements all required properties.
Defines list of media types that this parser adapter recognizes.
[
'application/vnd.oai.openapi;version=3.1.0',
'application/vnd.oai.openapi+yaml;version=3.1.0',
]
Detection is based on a regular expression matching required OpenAPI 3.1.0 specification symbols in YAML format.
This adapter exposes an instance of OpenAPI 3.1.0 ApiDOM namespace.
parse
function consumes various options as a second argument. Here is a list of these options:
Option | Type | Default | Description |
---|---|---|---|
specObj | Object | Specification Object | This specification object drives the YAML AST transformation to OpenAPI 3.1.0 ApiDOM namespace. |
sourceMap | Boolean | false | Indicate whether to generate source maps. |
refractorOpts | Object | {} | Refractor options are passed to refractors during refracting phase. |
All unrecognized arbitrary options will be ignored.
This parser adapter can be used directly or indirectly via apidom-parser.
During direct usage you don't need to provide mediaType
as the parse
function is already pre-bound
with supported media types.
import { parse, detect } from '@swagger-api/apidom-parser-adapter-openapi-yaml-3-1';
// detecting
await detect('openapi: 3.1.0'); // => true
await detect('test'); // => false
// parsing
const parseResult = await parse('openapi: 3.1.0', { sourceMap: true });
You can omit the mediaType
option here, but please read Word on detect vs mediaTypes before you do so.
import ApiDOMParser from '@swagger-api/apidom-parser';
import * as openApiYamlAdapter from '@swagger-api/apidom-parser-adapter-openapi-yaml-3-1';
const parser = new ApiDOMParser();
parser.use(openApiYamlAdapter);
const parseResult = await parser.parse('openapi: 3.1.0', { mediaType: openApiYamlAdapter.mediaTypes.latest('yaml') });
FAQs
Parser adapter for parsing YAML documents into OpenAPI 3.1.x namespace.
The npm package @swagger-api/apidom-parser-adapter-openapi-yaml-3-1 receives a total of 323,121 weekly downloads. As such, @swagger-api/apidom-parser-adapter-openapi-yaml-3-1 popularity was classified as popular.
We found that @swagger-api/apidom-parser-adapter-openapi-yaml-3-1 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.