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

[Graph Docs] Update snippet generator to skip adding Try It button to examples with placeholders #2148

Open
Lauragra opened this issue Aug 14, 2024 · 1 comment
Labels
status:waiting-for-author-feedback Issue that we've responded but needs author feedback to close

Comments

@Lauragra
Copy link

Lauragra commented Aug 14, 2024

Is your feature request related to a problem? Please describe.
Currently, the Try It button is added to all GET operation topics via the snippet generation process. However, some examples include only placeholder values, and therefore the Try It experience won't work directly without additional steps by the user.

Describe the solution you'd like
We don't want to add the Try It button automatically to GET operation examples that have placeholders or fictitious values. We propose that the snippet process leave the HTTP tab as-is without adding msgraph-interactive in the following cases:

  • When the example includes {} placeholder values.
  • When the example uses fictitious values specified in the sampleKeys property of the HTML comment block.

Describe alternatives you've considered
Manually removing them doesn't work because the process currently adds it back via automation.

@timayabi2020
Copy link
Contributor

Hi @Lauragra could you please provide an example of an API path that exhibits this behavior?

@timayabi2020 timayabi2020 added the status:waiting-for-author-feedback Issue that we've responded but needs author feedback to close label Nov 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status:waiting-for-author-feedback Issue that we've responded but needs author feedback to close
Projects
None yet
Development

No branches or pull requests

2 participants