Skip to content

oaimerge loads an openapi yaml specification, applies a variable interpolation and merges everything into a single openapi json

License

Notifications You must be signed in to change notification settings

worldiety/oaimerge

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

oaimerge

oaimerge loads an openapi yaml specification (eventually from multiple files), applies a variable interpolation and merges everything into a single openapi json. Additional checks or linting rules are not applied.

why would one ever need that?

For example, if you want to use external descriptions (e.g. because you have used xtractdoc), there is currently no support from the OpenAPI specification. See also the following related tickets:

See also RFC3986. In contrast to the official OAI spec, $ref is allowed anywhere, only limited by the yaml grammar.

usage

go install github.com/worldiety/oaimerge/cmd/oaimerge@latest
oaimerge -oai=openapi.yaml > mergedoai.json

limitations

  • supports only local relative yaml files. There is no generic URI or URL support
  • string interpolation works only for inline strings of the form $ref{filename#/wdy.de-my/jsonptr}

About

oaimerge loads an openapi yaml specification, applies a variable interpolation and merges everything into a single openapi json

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages