Import/Embed YAML in Markdown

[wwfiserv]

Context

Currently to document examples or the Schema from the YAML it requires a manual process. See original ticket https://github.com/Fiserv/Support/issues/336

Solution

We previously had a ticket requesting the option to import/embed the YAML information in a Markdown file. This would mean as the YAML is updated documentation would render the updated info without manually having to update it.

Alternatives

I found something that supports YAML to markdown as long as it can be rendered, it's called Markdown YAML Preamble, which loads the YAML front matter render as a table.

Example format;

---
name: John Doe
age: 30
gender: Male
---

Additional Context

Object/Field Example: should be able to reference a single object to have it display formatted in the markdown file with the relevant information.

Payload Request/Response Example: should be able to reference an endpoint definition to have it display the default example with a dropdown to change the example similar to API explorer.

Region

No response

[stale[bot]]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[wwfiserv]

commenting to prevent stale