Hi, All,
I see some .md files in folder awx/api/templates/api. But they do not look like Markdown Documentation files, more like jinja2 files. Anyone can tell me what kind of format those .md files are, and how to read them? Cause I see it combines logic control keywords and comments.
Thanks,
Lei
These things are rendered in the api OPTIONS request (go to some endpoint in the api browser ($towerhost/api/v2/$end_point) and click the options button in the top-right corner). I’m assuming that the jinja2 is interpolated and rendered by something Django Rest Framework in some way.
The goal is self-documentation of these endpoints.
Hope that helps,
John
The API is using Django’s template engine (https://docs.djangoproject.com/en/1.11/topics/templates/#the-django-template-language), which looks similar to Jinja, to render the markdown for the “description” field returned from the OPTIONS request and the help text available in the browsable API.