Skip to content

tmforum-rand/swagger2oas

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Used to convert V4 to V5

Install

npm install

Run rule conversion

Use absolute paths.

node rules2oas --input <v4_api_dir>/<v4.rules.yaml> \
      --schema-directory <v5_schema_dir> \
      --api-target-directory <v5_api_dir> \
      --output <v5_api_dir>/<v5_api.rules.yaml> \
      --add-notification-examples (optional) \
      --validate-properties  (optional) \
      --overwrite-events (optional - default false) \
      --overwrite-examples (optional - default false)

Output is by default derived from the <v4.rules.yaml> using the agreed v5 naming.

Output can also be specfied with --output <file>

The v5_schema_dir would typically be OAS_Open_API_And_Data_Model/schemas.

The v5_api_dir would typically be OAS_Open_API_And_Data_Model/apis/<API name>

Examples from v4 are located from the input v4 rules file name and assuming documentation\resource_samplesetc.

About

Conversion of v4 rules to v5 (OAS3)

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors