Skip to content
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

feat: more examples for request/response pairs #102

Merged
merged 5 commits into from
Apr 17, 2024

Conversation

kanadgupta
Copy link
Member

@kanadgupta kanadgupta commented Apr 17, 2024

🧰 Changes

Enhancing a couple existing definitions (3.0/json/readme-extensions.json, 3.0/json/request-examples.json) so we have a variety of test cases for request/response example pair support.

🧬 QA & Testing

Do these examples validate and seem sound? I synced them to this test project if you want to give them a whirl:

https://kanad-rdme.readme.io/reference/x-readme_code-samples
https://kanad-rdme.readme.io/reference/get_parameterexamples-param1-param2

@kanadgupta kanadgupta added the enhancement New feature or request label Apr 17, 2024
@kanadgupta kanadgupta marked this pull request as ready for review April 17, 2024 21:37
@kanadgupta kanadgupta requested a review from erunion April 17, 2024 21:37
Copy link
Member

@erunion erunion left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you clone these same changes to the .yaml counterparts? To do that I usually just copy-paste the JSON into https://www.bairesdev.com/tools/json2yaml/ and remove the --- header that that thing adds to the top.

It's nice that the YAML and JSON versions of these examples are identical.

@kanadgupta
Copy link
Member Author

@erunion fixed! thanks for flagging i missed that

@kanadgupta kanadgupta requested a review from erunion April 17, 2024 21:58
@erunion erunion merged commit d056184 into main Apr 17, 2024
3 checks passed
@erunion erunion deleted the kanad-2024-04-17/req-res-pairs branch April 17, 2024 21:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants