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.

Sign up for GitHub

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

Jump to bottom

Response example generation for XML and CSV #2347

Open
wants to merge 16 commits into
base: main
Choose a base branch
from
Open

Response example generation for XML and CSV #2347

Changes from 1 commit
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
00256a8
FBI-451: Implement XML example code generation for Redoc
rishitank Jun 13, 2023
b13b139
random commit
rishitank Jun 13, 2023
18aadd5
FBI-451: Improve example ID
rishitank Jun 14, 2023
eee14dd
FBI-451: Provide `codeSamplesLanguage` as an option
rishitank Jun 14, 2023
d1b54be
FBI-451: Provide `codeSamplesLanguage` as an option
rishitank Jun 14, 2023
7eac7e8
Merge branch 'feature-FBI-451-implement-xml-response-example-generati…
rishitank Jun 14, 2023
8e56a3b
FBI-451: clean up
rishitank Jun 14, 2023
f29b7ae
FBI-451: clean up
rishitank Jun 14, 2023
69c7fc4
FBI-451: address CR comments
rishitank Jun 19, 2023
55c66f6
Merge pull request #3 from Adthena/feature-FBI-451-implement-xml-resp…
rishitank Jun 19, 2023
068ba23
FBI-459: Implement CSV code sample generation for redoc
rishitank Jun 21, 2023
c4133cf
FBI-459: improvements
rishitank Jun 22, 2023
1d4c0dc
FBI-459: improvements
rishitank Jun 22, 2023
8080b33
Merge pull request #5 from Adthena/feature-FBI-459-implement-csv-code…
rishitank Jun 22, 2023
2ef6a02
FBI-287: update readme
rishitank Jun 26, 2023
33f167e
FBI-287: update readme
rishitank Jun 29, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
FBI-451: clean up
  • Loading branch information
@rishitank
rishitank committed Jun 14, 2023
commit 8e56a3b12511a8e58594b6899e8ce9e0fc4ffaa1
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -251,7 +251,7 @@ You can use all of the following options with the standalone version of the <red
* **path-only**: displays a path in the sidebar navigation item.
* **id-only**: displays the operation id with a fallback to the path in the sidebar navigation item.
* `showWebhookVerb` - when set to `true`, shows the HTTP request method for webhooks in operations and in the sidebar.
* `codeSamplesLanguage` - enables code sample generation for the provided list of languages.
* `codeSamplesLanguages` - enables code sample generation for the provided list of languages.
Copy link
Member

Choose a reason for hiding this comment

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

I wonder why this is needed? Can we not determine this from the content type? (application/json, vs application/xml, vs text/csv)?

Copy link
Author

Choose a reason for hiding this comment

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

This is used to allow the user to control for which media types they want code examples to show up rather than showing all code examples for all media types supported (in case the user doesn't want code examples for certain media types to show up by default).


### `<redoc>` theme object
* `spacing`
Expand Down