allow for custom code example tabs #589
Closed
Conversation
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
|
🎉 Thanks for opening this pull request! We really appreciate contributors like you! 🙌 |
|
Visit the preview URL for this PR (updated for commit ae2a34e): https://docusaurus-openapi-36b86--pr589-r20tl7aq.web.app (expires Sun, 29 Oct 2023 20:23:09 GMT) 🔥 via Firebase Hosting GitHub Action 🌎 |
|
Hi @joecrop, I was curious if you have any plans to move to v2.0.0? I haven't tested but I'm wondering if the same issue occurs with v2. |
4 tasks
I could replicate the same issue with |
|
Actually, I think the problem is more nuanced than this. When I apply this
patch I can get the custom code samples to work, but it broke some other
feature (custom icons maybe, I don't remember). So I think we should close
this and maybe create an issue for a more comprehensive fix.
…On Thu, Jan 11, 2024 at 9:12 AM Lucas Rosa ***@***.***> wrote:
Hi @joecrop <https://github.com/joecrop>, I was curious if you have any
plans to move to v2.0.0? I haven't tested but I'm wondering if the same
issue occurs with v2.
I could replicate the same issue with v2 after fixing the typo on
x-codeSamples extension usage
—
Reply to this email directly, view it on GitHub
<#589 (comment)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AAW66QMJ4IPUV6DIT652OB3YOAMOTAVCNFSM6AAAAAAYZB2KHKVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTQOBXGYYDEOBZGQ>
.
You are receiving this because you were mentioned.Message ID:
***@***.***>
|
4 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
There seems to be some support for an
x-code-samplesproperty to display custom code samples. However, when doing this, theCodeTabscomponent is only aware of the default auto-generated samples. So when you click on a tab for a custom code sample, the component can't find the Language and bombs.It's not clear to me that the
x-code-samplesproperty is intended to be fully supported. I can't find any documentation about support or a working example, so it's unclear to me if there are tests that should be added/updated.Motivation and Context
When using
x-code-samples, clicking on a tab for a custom code sample, the component can't find the Language and bombs.How Has This Been Tested?
This was tested manually using an openAPI spec with and without the
x-code-samplesproperty.Types of changes
Checklist