Added support for injecting MD files. Any extension starts with 'x-md… #327
Conversation
…-*' will be treated as md file path, and loaded into 'md_*' property. The content of the MD file can be accessed in the templates.
There was a problem hiding this comment.
Thanks for the PR! In addition to the minor comments, I have some questions on the approach. Where in the input definition can x-md- extensions appear, is it only on paths and tags? I think it would be more generally useful if the approach could be widened a bit, so that it applied equally well to AsyncAPI (i.e. was moved to lib/common.js) and we found some way to deepen the ability to attach the extensions to more points in the input.
We would also need documentation changes and potentially a switch to control this / control the extension prefix.
lib/openapi3.js
Outdated
| for (let field in sourceSection) { | ||
| if (field.startsWith("x-md-")) { | ||
| //Replacing '-' so that field can be used in dot templates | ||
| let newFieldName = field.replace("x-md-", "md_"); |
There was a problem hiding this comment.
Should we replace all - with _ not just the first two? Either with a split/join or a .replace.
lib/openapi3.js
Outdated
| if (field.startsWith("x-md-")) { | ||
| //Replacing '-' so that field can be used in dot templates | ||
| let newFieldName = field.replace("x-md-", "md_"); | ||
| destSection[newFieldName] = await fs.readFile(sourceSection[field], 'utf8'); |
There was a problem hiding this comment.
Missing error handling on the readFile.
lib/openapi3.js
Outdated
| @@ -104,8 +124,7 @@ function fakeProdCons(data) { | |||
| let schema = op.requestBody.content[rb].schema; | |||
| if (schema['x-widdershins-oldRef']) { | |||
| data.bodyParameter.refName = schema['x-widdershins-oldRef'].replace('#/components/schemas/', ''); | |||
| } | |||
| else { | |||
There was a problem hiding this comment.
This is the first of many unrelated formatting changes even with GitHub diff set to ignore whitespace changes. Could we lose these please?
…d allowing the MD field prefix to be configured
� Conflicts: � lib/openapi3.js
|
@MikeRalphson I've made the changes you asked. I added support to loading MD everywhere extensions are allowed, according to: https://swagger.io/docs/specification/openapi-extensions/. |
|
@MikeRalphson Could you please take a look? |
|
@TomerG711 thanks for your patience. I'm evaluating a slightly different solution whereby we simply Regardless of which approach we go with, I think we would need to support |
|
So should I add support for fetching remote resources or should I leave it for you with the other solution? |
…-' will be treated as md file path, and loaded into 'md_' property. The content of the MD file can be accessed in the templates.
This will allow us to create much more complex MD files, making Widdershins much more flexible.