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
mikekistler
reviewed
Aug 14, 2024
ralfhandl
commented
Aug 15, 2024
Contributor
Author
There was a problem hiding this comment.
Don't yamlize examples
This was referenced Aug 16, 2024
handrews
approved these changes
Aug 20, 2024
Member
handrews
left a comment
There was a problem hiding this comment.
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
miqui
approved these changes
Aug 21, 2024
Contributor
|
checked the md, looks good to me. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
titlein 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