-
Notifications
You must be signed in to change notification settings - Fork 60
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add pages for OAD examples #105
Conversation
because the highlighted ones false positives (bug in kramdown/rouge? don't want to invest time), and we test the YAML files against the JSON Schema for OpenAPI, so they are more than just syntactically correct
examples/v3.0/api-with-examples.yaml
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Don't yamlize examples
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm assuming all the noise in the json/yaml files is auto-reformatting and didn't review it in detail (looks fine based on a skim).
I did check the markdown, page titles, and other files, and they all look good.
and adjust workflow to use same formatter
checked the md, looks good to me. |
Part of OAI/OpenAPI-Specification#3854
Each example to be shown on the site needs a small markdown file which pulls in the JSON and YAML files via an include:
The
title
in the front matter determines which sibling JSON and YAML files are embedded in code blocks, the name of the markdown file itself is irrelevant, although it is nice to use the same basename as for the JSON and YAML files.See rendering on https://ralfhandl.github.io/learn.openapis.org/examples/v3.1/non-oauth-scopes.html