Mrm task that creates and infers OpenAPI specification with values from package.json
.
- Populates OpenAPI Info Object
- Populates
title
string field withname
field inpackage.json
. - Populates
description
string field withdescription
field inpackage.json
. - Populates
license
License Object field withlicense
field inpackage.json
.- Only supports SPDX license identifiers.
- Multiple licenses are not supported in OpenAPI specification which means SPDX multi-license expressions (e.g.
(ISC OR MIT)
) is not supported.
- Populates
version
string field withversion
field inpackage.json
. - Populates
contact
Contact Object field withauthor
field inpackage.json
.- String shortform (e.g.
"Tim Apple <tim@apple.com> (https://www.apple.com/)"
) will be parsed and expanded into a Person Object before being converted into a Contact Object.
- String shortform (e.g.
- Populates
npx mrm openapi
Location of the OpenAPI specification file.
OpenAPI specification version. See all versions.
Title of the API. Does not override existing title
in the OpenAPI specification file unless the field is deleted or override
configuration is set.
A description of the API. Does not override existing description
in the OpenAPI specification file unless the field is deleted or override
configuration is set.
The version of the OpenAPI document. Always overrides version
in the OpenAPI Info Object unless override
configuration is set otherwise.
The license information for the exposed API. Must be in SPDX license identifier format. If set to NONE
or UNLICENSED
, this field will NOT be populated in the specification file. Always overrides license
License Object unless override
configuration is set otherwise.
The contact information for the exposed API. Does not override existing contact
Contact Object in the OpenAPI specification file unless the field is deleted or override
configuration is set.
Comma delimited string of field names to override with value from package.json
every time this task runs.
Version string for SPDX license list database.
The changelog can be found on the Releases page.
Everyone is welcome to contribute. Please take a moment to review the contributing guidelines.
Andrew Jo and contributors.
BSD 3-Clause License, see the included LICENSE.md file.