Socket
Socket
Sign inDemoInstall

@swagger-api/apidom-parser-adapter-workflows-yaml-1

Package Overview
Dependencies
70
Maintainers
1
Versions
20
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    @swagger-api/apidom-parser-adapter-workflows-yaml-1

Parser adapter for parsing YAML documents into Workflows 1.x.y namespace.


Version published
Weekly downloads
285K
decreased by-3.91%
Maintainers
1
Created
Weekly downloads
 

Changelog

Source

1.0.0-alpha.5 (2024-05-29)

Bug Fixes

  • deps: add apidom-error package as direct dependency (#4154) (f076207)
  • reference: fix versioning of optional dependencies (#4153) (e561bd7)

Readme

Source

@swagger-api/apidom-parser-adapter-workflows-yaml-1

@swagger-api/apidom-parser-adapter-workflows-yaml-1-0 is a parser adapter for the Workflows 1.x.x 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 Workflows 1.x.y Refractors.

Installation

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-workflows-yaml-1

Parser adapter API

This parser adapter is fully compatible with parser adapter interface required by @swagger-api/apidom-parser and implements all required properties.

mediaTypes

Defines list of media types that this parser adapter recognizes.

[
  'application/vnd.oai.workflows;version=1.0.0',
  'application/vnd.oai.workflows+yaml;version=1.0.0',
]

detect

Detection is based on a regular expression matching required Workflows 1.0.0 specification symbols in YAML format.

namespace

This adapter exposes an instance of Workflows 1.x.y ApiDOM namespace.

parse

parse function consumes various options as a second argument. Here is a list of these options:

OptionTypeDefaultDescription
specObjObjectSpecification ObjectThis specification object drives the YAML AST transformation to Workflows 1.x.y ApiDOM namespace.
sourceMapBooleanfalseIndicate whether to generate source maps.
refractorOptsObject{}Refractor options are passed to refractors during refracting phase.

All unrecognized arbitrary options will be ignored.

Usage

This parser adapter can be used directly or indirectly via @swagger-api/apidom-parser.

Direct usage

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-workflows-yaml-1';

// detecting
await detect('workflowsSpec: 1.0.0'); // => true
await detect('test'); // => false

// parsing
const parseResult = await parse('workflowsSpec: 1.0.0', { sourceMap: true });

Indirect usage

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 workflowsYamlAdapter from '@swagger-api/apidom-parser-adapter-workflows-yaml-1';

const parser = new ApiDOMParser();

parser.use(workflowsYamlAdapter);

const parseResult = await parser.parse('workflowsSpec: 1.0.0', { mediaType: workflowsYamlAdapter.mediaTypes.latest('yaml') });

FAQs

Last updated on 29 May 2024

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.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc