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

guides: support verbatim variables #3871

Merged
merged 8 commits into from
Oct 3, 2024
Merged

guides: support verbatim variables #3871

merged 8 commits into from
Oct 3, 2024

Conversation

millotp
Copy link
Collaborator

@millotp millotp commented Oct 2, 2024

🧭 What and Why

🎟 JIRA Ticket: DI-2984

Support variables insertion in the guides, to use an existing variable instead of defining everything in json.
The syntax is:

"parameters": {
  "propName": "$var: theVarToInsert"
}

@millotp millotp self-assigned this Oct 2, 2024
@algolia-bot
Copy link
Collaborator

algolia-bot commented Oct 2, 2024

✔️ Code generated!

Name Link
🪓 Triggered by 88ff534dc24a4654700f40b8a94bf2b47b33a903
🍃 Generated commit 8cc07dd106bf1649531d2cd8e0a3b4ed392682ff
🌲 Generated branch generated/feat/verbatim
📊 Benchmark results

Benchmarks performed on the method using a mock server, the results might not reflect the real-world performance.

Language Req/s
javascript 1648
go 1611
php 1508
csharp 1349
java 1108
python 1016
ruby 854
swift 765

@millotp millotp marked this pull request as ready for review October 3, 2024 07:48
@millotp millotp requested a review from a team as a code owner October 3, 2024 07:48
Copy link
Contributor

@Fluf22 Fluf22 left a comment

Choose a reason for hiding this comment

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

We will need to write a guide on how to write a guide

@millotp
Copy link
Collaborator Author

millotp commented Oct 3, 2024

We will need to write a guide on how to write a guide

there is a ticket for that !

@millotp millotp merged commit 233cf76 into main Oct 3, 2024
28 checks passed
@millotp millotp deleted the feat/verbatim branch October 3, 2024 08:47
algolia-bot added a commit that referenced this pull request Oct 3, 2024
Co-authored-by: Pierre Millot <pierre.millot@algolia.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants