Integrate render route by dureuill · Pull Request #3602 · meilisearch/documentation

dureuill · 2026-06-19T14:39:09Z

Add POST /render-template to navigation (in Management > Template)
Add paragraph about testing templates to template best practices
Add code sample

Summary by CodeRabbit

Summary

Documentation
- Added a new “Template” reference section to highlight the POST /render-template capability.
- Expanded the document template best-practices guide with a “Test your template” section, including expected rendering results and an example error case when a referenced field is missing.
New Examples
- Introduced multiple curl-based render-template snippets, covering inline templates, index-backed templates, and missing-field templates.
API Reference (OpenAPI)
- Added an x-codeSamples cURL example for POST /render-template.

coderabbitai · 2026-06-19T14:39:26Z

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 79eaed89-f636-4679-bb12-513a7eb6b980

📥 Commits

Reviewing files that changed from the base of the PR and between 463bb55 and 2e5cd24.

📒 Files selected for processing (7)

.code-samples.meilisearch.yaml
assets/open-api/meilisearch-openapi-mintlify.json
capabilities/hybrid_search/advanced/document_template_best_practices.mdx
config/navigation.json
snippets/generated-code-samples/code_samples_render_template_guide_1.mdx
snippets/generated-code-samples/code_samples_render_template_guide_2.mdx
snippets/generated-code-samples/code_samples_render_template_guide_3.mdx

💤 Files with no reviewable changes (1)

assets/open-api/meilisearch-openapi-mintlify.json

✅ Files skipped from review due to trivial changes (5)

snippets/generated-code-samples/code_samples_render_template_guide_3.mdx
snippets/generated-code-samples/code_samples_render_template_guide_1.mdx
snippets/generated-code-samples/code_samples_render_template_guide_2.mdx
.code-samples.meilisearch.yaml
capabilities/hybrid_search/advanced/document_template_best_practices.mdx

🚧 Files skipped from review as they are similar to previous changes (1)

config/navigation.json

📝 Walkthrough

Walkthrough

Adds render-template documentation examples, a navigation entry, a template-testing guide section, and OpenAPI schema updates for the endpoint and related chat types.

Changes

POST /render-template Documentation

Layer / File(s)	Summary
Code samples, snippets, and navigation `.code-samples.meilisearch.yaml`, `snippets/generated-code-samples/code_samples_render_template_guide_1.mdx`, `snippets/generated-code-samples/code_samples_render_template_guide_2.mdx`, `snippets/generated-code-samples/code_samples_render_template_guide_3.mdx`, `config/navigation.json`	Adds render-template curl examples to the shared code-sample source and generated MDX snippets, including inline document templates, indexed document input, and a missing-field example. Registers a new “Template” navigation group under “Management” pointing to the `POST /render-template` page.
Template-testing guide section `capabilities/hybrid_search/advanced/document_template_best_practices.mdx`	Adds imports for the generated snippets and a new “Test your template” section that shows inline template rendering, indexed document rendering, and the missing-field error response.
OpenAPI endpoint example and chat schemas `assets/open-api/meilisearch-openapi-mintlify.json`	Adds the `POST /render-template` code sample to the OpenAPI document and adds or relocates the chat workspace and chat completion-related schemas in the components section.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Poem

🐇 Hop to the template gate, so bright,
Curl samples sparkle in docs tonight.
One field missing? The error sings,
While chat schemas shuffle and OpenAPI rings.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Title check	❓ Inconclusive	The title is related to the new render-template docs, but it is vague and does not clearly state the main change.	Rename it to clearly mention the new POST /render-template documentation or template rendering guide updates.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Commit unit tests in branch add-render-template-route

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands.}

mintlify · 2026-06-19T14:39:37Z

Preview deployment for your docs. Learn more about Mintlify Previews.

Project	Status	Preview	Updated (UTC)
meilisearch-documentation	🔴 Failed	–	Jun 19, 2026, 2:39 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

coderabbitai

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@capabilities/hybrid_search/advanced/document_template_best_practices.mdx`:
- Around line 52-64: The curl command examples in the
document_template_best_practices.mdx file are incorrectly fenced with json code
blocks instead of bash code blocks. Change the code fence markers from json to
bash for all three curl command examples located at lines 52-64, 88-103, and
126-137 to make the samples clear and properly runnable according to coding
guidelines.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

Push a commit to this branch (recommended)
Create a new PR with the fixes

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 73a29d88-b51f-4d88-b0f5-914eb781a06d

📥 Commits

Reviewing files that changed from the base of the PR and between 2de0813 and c2f1ba1.

📒 Files selected for processing (3)

.code-samples.meilisearch.yaml
capabilities/hybrid_search/advanced/document_template_best_practices.mdx
config/navigation.json

CaroFG · 2026-06-22T09:35:44Z

@qdequele do you know why the mintlify deployment is failing?

qdequele · 2026-06-22T09:59:45Z

@qdequele do you know why the mintlify deployment is failing?

The issue is about the OpenAPI not available.

Add missing quotes Co-authored-by: CaroFG <48251481+CaroFG@users.noreply.github.com>

qdequele · 2026-06-23T15:32:20Z

@dureuill and @CaroFG sorry for the delay, but the openapi file was not up to date and missing the newly introduced route.

Replace inline curl blocks (tagged as json) in the document template best practices guide with generated code-sample snippets, matching the rest of the documentation. Adds render_template_guide_1/2/3 to .code-samples.meilisearch.yaml and the corresponding generated snippets.

qdequele · 2026-06-24T15:52:21Z

@dureuill I updated the code sample, if it's ok for you we can go with that!

dureuill · 2026-06-25T07:14:31Z

thank you @qdequele !

this will allow SDKs to put an example in their language, is that correct? If so, great!

qdequele · 2026-06-25T09:49:12Z

this will allow SDKs to put an example in their language, is that correct? If so, great!

Yes exactly.

CaroFG · 2026-06-26T06:53:08Z

Is there anything pending before we can merge @qdequele @dureuill ?

dureuill requested a review from a team as a code owner June 19, 2026 14:39

dureuill requested review from CaroFG and qdequele June 19, 2026 14:39

coderabbitai Bot reviewed Jun 19, 2026

View reviewed changes

Comment thread capabilities/hybrid_search/advanced/document_template_best_practices.mdx Outdated

CaroFG requested changes Jun 22, 2026

View reviewed changes

Comment thread capabilities/hybrid_search/advanced/document_template_best_practices.mdx Outdated

Comment thread capabilities/hybrid_search/advanced/document_template_best_practices.mdx Outdated

dureuill requested a review from CaroFG June 22, 2026 09:34

CaroFG approved these changes Jun 22, 2026

View reviewed changes

dureuill and others added 4 commits June 23, 2026 17:25

Add render template route to navigation

970c051

Add some guide about testing templates in template best practices

e0781ae

Add code sample

cf4b1c0

Apply suggestions from code review

8994931

Add missing quotes Co-authored-by: CaroFG <48251481+CaroFG@users.noreply.github.com>

qdequele force-pushed the add-render-template-route branch from 463bb55 to 8994931 Compare June 23, 2026 15:25

qdequele added 2 commits June 23, 2026 17:29

chore: add the v1.48 verison of openapi

254c64b

Merge branch 'main' into add-render-template-route

a951d1b

mintlify Bot deployed to staging June 23, 2026 15:31 View deployment

Uh oh!

Conversation

dureuill commented Jun 19, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Summary

Uh oh!

coderabbitai Bot commented Jun 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Poem

❌ Failed checks (1 inconclusive)

Uh oh!

mintlify Bot commented Jun 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

CaroFG commented Jun 22, 2026

Uh oh!

qdequele commented Jun 22, 2026

Uh oh!

qdequele commented Jun 23, 2026

Uh oh!

qdequele commented Jun 24, 2026

Uh oh!

dureuill commented Jun 25, 2026

Uh oh!

qdequele commented Jun 25, 2026

Uh oh!

CaroFG commented Jun 26, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

dureuill commented Jun 19, 2026 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented Jun 19, 2026 •

edited

Loading

mintlify Bot commented Jun 19, 2026 •

edited

Loading