Skip to content

Commit

Permalink
Merge pull request #73 from k-yomo/update-docs
Browse files Browse the repository at this point in the history 
Update docs
  • Loading branch information
@k-yomo
k-yomo authored Mar 16, 2022
2 parents c1c1a93 + da92573 commit aa7fd6d
Show file tree
Hide file tree
Showing 8 changed files with 217 additions and 217 deletions.
142 changes: 71 additions & 71 deletions docs/data-sources/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,100 +23,100 @@ data "algolia_index" "example" {

### Required

- **name** (String) Name of the index.
- `name` (String) Name of the index.

### Optional

- **id** (String) The ID of this resource.
- `id` (String) The ID of this resource.

### Read-Only

- **advanced_config** (List of Object) The configuration for advanced features in index setting. (see [below for nested schema](#nestedatt--advanced_config))
- **attributes_config** (List of Object) The configuration for attributes. (see [below for nested schema](#nestedatt--attributes_config))
- **enable_personalization** (Boolean) Whether to enable the Personalization feature.
- **enable_rules** (Boolean) Whether Rules should be globally enabled.
- **faceting_config** (List of Object) The configuration for faceting. (see [below for nested schema](#nestedatt--faceting_config))
- **highlight_and_snippet_config** (List of Object) The configuration for highlight / snippet in index setting. (see [below for nested schema](#nestedatt--highlight_and_snippet_config))
- **languages_config** (List of Object) The configuration for languages in index setting. (see [below for nested schema](#nestedatt--languages_config))
- **pagination_config** (Block List) The configuration for pagination in index setting. (see [below for nested schema](#nestedblock--pagination_config))
- **performance_config** (List of Object) The configuration for performance in index setting. (see [below for nested schema](#nestedatt--performance_config))
- **query_strategy_config** (List of Object) The configuration for query strategy in index setting. (see [below for nested schema](#nestedatt--query_strategy_config))
- **ranking_config** (List of Object) The configuration for ranking. (see [below for nested schema](#nestedatt--ranking_config))
- **typos_config** (List of Object) The configuration for typos in index setting. (see [below for nested schema](#nestedatt--typos_config))
- **virtual** (Boolean) Whether the index is virtual index.
- `advanced_config` (List of Object) The configuration for advanced features in index setting. (see [below for nested schema](#nestedatt--advanced_config))
- `attributes_config` (List of Object) The configuration for attributes. (see [below for nested schema](#nestedatt--attributes_config))
- `enable_personalization` (Boolean) Whether to enable the Personalization feature.
- `enable_rules` (Boolean) Whether Rules should be globally enabled.
- `faceting_config` (List of Object) The configuration for faceting. (see [below for nested schema](#nestedatt--faceting_config))
- `highlight_and_snippet_config` (List of Object) The configuration for highlight / snippet in index setting. (see [below for nested schema](#nestedatt--highlight_and_snippet_config))
- `languages_config` (List of Object) The configuration for languages in index setting. (see [below for nested schema](#nestedatt--languages_config))
- `pagination_config` (Block List) The configuration for pagination in index setting. (see [below for nested schema](#nestedblock--pagination_config))
- `performance_config` (List of Object) The configuration for performance in index setting. (see [below for nested schema](#nestedatt--performance_config))
- `query_strategy_config` (List of Object) The configuration for query strategy in index setting. (see [below for nested schema](#nestedatt--query_strategy_config))
- `ranking_config` (List of Object) The configuration for ranking. (see [below for nested schema](#nestedatt--ranking_config))
- `typos_config` (List of Object) The configuration for typos in index setting. (see [below for nested schema](#nestedatt--typos_config))
- `virtual` (Boolean) Whether the index is virtual index.

<a id="nestedatt--advanced_config"></a>
### Nested Schema for `advanced_config`

Read-Only:

- **attribute_criteria_computed_by_min_proximity** (Boolean)
- **attribute_for_distinct** (String)
- **distinct** (Number)
- **max_facet_hits** (Number)
- **min_proximity** (Number)
- **replace_synonyms_in_highlight** (Boolean)
- **response_fields** (Set of String)
- `attribute_criteria_computed_by_min_proximity` (Boolean)
- `attribute_for_distinct` (String)
- `distinct` (Number)
- `max_facet_hits` (Number)
- `min_proximity` (Number)
- `replace_synonyms_in_highlight` (Boolean)
- `response_fields` (Set of String)


<a id="nestedatt--attributes_config"></a>
### Nested Schema for `attributes_config`

Read-Only:

- **attributes_for_faceting** (Set of String)
- **attributes_to_retrieve** (Set of String)
- **searchable_attributes** (List of String)
- **unretrievable_attributes** (Set of String)
- `attributes_for_faceting` (Set of String)
- `attributes_to_retrieve` (Set of String)
- `searchable_attributes` (List of String)
- `unretrievable_attributes` (Set of String)


<a id="nestedatt--faceting_config"></a>
### Nested Schema for `faceting_config`

Read-Only:

- **max_values_per_facet** (Number)
- **sort_facet_values_by** (String)
- `max_values_per_facet` (Number)
- `sort_facet_values_by` (String)


<a id="nestedatt--highlight_and_snippet_config"></a>
### Nested Schema for `highlight_and_snippet_config`

Read-Only:

- **attributes_to_highlight** (Set of String)
- **attributes_to_snippet** (Set of String)
- **highlight_post_tag** (String)
- **highlight_pre_tag** (String)
- **restrict_highlight_and_snippet_arrays** (Boolean)
- **snippet_ellipsis_text** (String)
- `attributes_to_highlight` (Set of String)
- `attributes_to_snippet` (Set of String)
- `highlight_post_tag` (String)
- `highlight_pre_tag` (String)
- `restrict_highlight_and_snippet_arrays` (Boolean)
- `snippet_ellipsis_text` (String)


<a id="nestedatt--languages_config"></a>
### Nested Schema for `languages_config`

Read-Only:

- **attributes_to_transliterate** (Set of String)
- **camel_case_attributes** (Set of String)
- **custom_normalization** (Map of String)
- **decompound_query** (Boolean)
- **decompounded_attributes** (List of Object) (see [below for nested schema](#nestedobjatt--languages_config--decompounded_attributes))
- **ignore_plurals** (Boolean)
- **ignore_plurals_for** (Set of String)
- **index_languages** (Set of String)
- **keep_diacritics_on_characters** (String)
- **query_languages** (Set of String)
- **remove_stop_words** (Boolean)
- **remove_stop_words_for** (Set of String)
- `attributes_to_transliterate` (Set of String)
- `camel_case_attributes` (Set of String)
- `custom_normalization` (Map of String)
- `decompound_query` (Boolean)
- `decompounded_attributes` (List of Object) (see [below for nested schema](#nestedobjatt--languages_config--decompounded_attributes))
- `ignore_plurals` (Boolean)
- `ignore_plurals_for` (Set of String)
- `index_languages` (Set of String)
- `keep_diacritics_on_characters` (String)
- `query_languages` (Set of String)
- `remove_stop_words` (Boolean)
- `remove_stop_words_for` (Set of String)

<a id="nestedobjatt--languages_config--decompounded_attributes"></a>
### Nested Schema for `languages_config.decompounded_attributes`

Read-Only:

- **attributes** (Set of String)
- **language** (String)
- `attributes` (Set of String)
- `language` (String)



Expand All @@ -125,56 +125,56 @@ Read-Only:

Read-Only:

- **hits_per_page** (Number) The number of hits per page.
- **pagination_limited_to** (Number) The maximum number of hits accessible via pagination
- `hits_per_page` (Number) The number of hits per page.
- `pagination_limited_to` (Number) The maximum number of hits accessible via pagination


<a id="nestedatt--performance_config"></a>
### Nested Schema for `performance_config`

Read-Only:

- **allow_compression_of_integer_array** (Boolean)
- **numeric_attributes_for_filtering** (Set of String)
- `allow_compression_of_integer_array` (Boolean)
- `numeric_attributes_for_filtering` (Set of String)


<a id="nestedatt--query_strategy_config"></a>
### Nested Schema for `query_strategy_config`

Read-Only:

- **advanced_syntax** (Boolean)
- **advanced_syntax_features** (Set of String)
- **alternatives_as_exact** (Set of String)
- **disable_exact_on_attributes** (Set of String)
- **disable_prefix_on_attributes** (Set of String)
- **exact_on_single_word_query** (String)
- **optional_words** (Set of String)
- **query_type** (String)
- **remove_words_if_no_results** (String)
- `advanced_syntax` (Boolean)
- `advanced_syntax_features` (Set of String)
- `alternatives_as_exact` (Set of String)
- `disable_exact_on_attributes` (Set of String)
- `disable_prefix_on_attributes` (Set of String)
- `exact_on_single_word_query` (String)
- `optional_words` (Set of String)
- `query_type` (String)
- `remove_words_if_no_results` (String)


<a id="nestedatt--ranking_config"></a>
### Nested Schema for `ranking_config`

Read-Only:

- **custom_ranking** (List of String)
- **ranking** (List of String)
- **replicas** (Set of String)
- `custom_ranking` (List of String)
- `ranking` (List of String)
- `replicas` (Set of String)


<a id="nestedatt--typos_config"></a>
### Nested Schema for `typos_config`

Read-Only:

- **allow_typos_on_numeric_tokens** (Boolean)
- **disable_typo_tolerance_on_attributes** (List of String)
- **disable_typo_tolerance_on_words** (List of String)
- **min_word_size_for_1_typo** (Number)
- **min_word_size_for_2_typos** (Number)
- **separators_to_index** (String)
- **typo_tolerance** (String)
- `allow_typos_on_numeric_tokens` (Boolean)
- `disable_typo_tolerance_on_attributes` (List of String)
- `disable_typo_tolerance_on_words` (List of String)
- `min_word_size_for_1_typo` (Number)
- `min_word_size_for_2_typos` (Number)
- `separators_to_index` (String)
- `typo_tolerance` (String)


20 changes: 10 additions & 10 deletions docs/resources/api_key.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ resource "algolia_api_key" "example" {

### Required

- **acl** (Set of String) Set of permissions associated with the key.
- `acl` (Set of String) Set of permissions associated with the key.
The possible ACLs are:
- `search`: allowed to perform search operations.
- `browse`: allowed to retrieve all index data with the browse endpoint.
Expand All @@ -48,20 +48,20 @@ The possible ACLs are:

### Optional

- **description** (String) Description of the API key.
- **expires_at** (String) Unix timestamp of the date at which the key expires. RFC3339 format. Will not expire per default.
- **id** (String) The ID of this resource.
- **indexes** (Set of String) List of targeted indices. You can target all indices starting with a prefix or ending with a suffix using the ‘*’ character. For example, “dev_*” matches all indices starting with “dev_” and “*_dev” matches all indices ending with “_dev”.
- **max_hits_per_query** (Number) Maximum number of hits this API key can retrieve in one call. This parameter can be used to protect you from attempts at retrieving your entire index contents by massively querying the index.
- **max_queries_per_ip_per_hour** (Number) Maximum number of API calls allowed from an IP address per hour.Each time an API call is performed with this key, a check is performed. If the IP at the source of the call did more than this number of calls in the last hour, a 429 code is returned.
- `description` (String) Description of the API key.
- `expires_at` (String) Unix timestamp of the date at which the key expires. RFC3339 format. Will not expire per default.
- `id` (String) The ID of this resource.
- `indexes` (Set of String) List of targeted indices. You can target all indices starting with a prefix or ending with a suffix using the ‘*’ character. For example, “dev_*” matches all indices starting with “dev_” and “*_dev” matches all indices ending with “_dev”.
- `max_hits_per_query` (Number) Maximum number of hits this API key can retrieve in one call. This parameter can be used to protect you from attempts at retrieving your entire index contents by massively querying the index.
- `max_queries_per_ip_per_hour` (Number) Maximum number of API calls allowed from an IP address per hour.Each time an API call is performed with this key, a check is performed. If the IP at the source of the call did more than this number of calls in the last hour, a 429 code is returned.

This parameter can be used to protect you from attempts at retrieving your entire index contents by massively querying the index.
- **referers** (Set of String) List of referrers that can perform an operation. You can use the “*” (asterisk) character as a wildcard to match subdomains, or all pages of a website. For example, `"https://algolia.com/\*"` matches all referrers starting with `"https://algolia.com/"`, and `"\*.algolia.com"` matches all referrers ending with `".algolia.com"`. If you want to allow all possible referrers from the `algolia.com` domain, you can use `"\*algolia.com/\*"`.
- `referers` (Set of String) List of referrers that can perform an operation. You can use the “*” (asterisk) character as a wildcard to match subdomains, or all pages of a website. For example, `"https://algolia.com/\*"` matches all referrers starting with `"https://algolia.com/"`, and `"\*.algolia.com"` matches all referrers ending with `".algolia.com"`. If you want to allow all possible referrers from the `algolia.com` domain, you can use `"\*algolia.com/\*"`.

### Read-Only

- **created_at** (Number) The unix time at which the key has been created.
- **key** (String, Sensitive) The created key.
- `created_at` (Number) The unix time at which the key has been created.
- `key` (String, Sensitive) The created key.

## Import

Expand Down
Loading

0 comments on commit aa7fd6d

Please sign in to comment.