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

Add template docs #5669

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add template docs #5669

wants to merge 1 commit into from

Conversation

rdettai
Copy link
Collaborator

@rdettai rdettai commented Feb 6, 2025

Description

Closes #4480

How was this PR tested?

Navigating the swagger UI

@rdettai rdettai self-assigned this Feb 6, 2025
@rdettai rdettai requested a review from guilload February 6, 2025 12:29
Copy link
Collaborator Author

@rdettai rdettai left a comment

Choose a reason for hiding this comment

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

FYI @Mo3m3n

@rdettai
Copy link
Collaborator Author

rdettai commented Feb 6, 2025

TODO: just noticed the auto_create_indexes also needs to be documented

EDIT: It is actually enabled by default (and hardcoded)

let cluster_config = ClusterConfig {
cluster_id,
auto_create_indexes: true,
default_index_root_uri,
replication_factor,
shard_throughput_limit: ingest_api_config.shard_throughput_limit,
};

Copy link
Member

@guilload guilload left a comment

Choose a reason for hiding this comment

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

Looking good, but can we use index template instead of simply template in the wording?

@@ -0,0 +1,111 @@
---
title: Template configuration
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
title: Template configuration
title: Index template configuration

toc_max_heading_level: 4
---

This page describes how to configure a template.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
This page describes how to configure a template.
This page describes how to configure an index template.


This page describes how to configure a template.

Templates let you dynamically create indexes according to predefined rules. Templates are used automatically when documents are received on the ingest API for an index that doesn't exist.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
Templates let you dynamically create indexes according to predefined rules. Templates are used automatically when documents are received on the ingest API for an index that doesn't exist.
Index templates let you dynamically create indexes according to predefined rules. Templates are used automatically when documents are received on the ingest API for an index that doesn't exist.

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.

Document Index Template API
2 participants