diff --git a/content/operate/rs/7.4/references/rest-api/objects/module.md b/content/operate/rs/7.4/references/rest-api/objects/module.md index de20d957ef..86d07b11d4 100644 --- a/content/operate/rs/7.4/references/rest-api/objects/module.md +++ b/content/operate/rs/7.4/references/rest-api/objects/module.md @@ -16,25 +16,24 @@ Represents a [Redis module]({{< relref "/operate/oss_and_stack/stack-with-enterp | Name | Type/Value | Description | |------|------------|-------------| | uid | string | Cluster unique ID of module | -| architecture | string | Architecture used to compile the module | | author | string | Module creator | | capabilities | array of strings | List of capabilities supported by this module | | capability_name | string | Short description of module functionality | | command_line_args | string | Command line arguments passed to the module | | config_command | string | Name of command to configure module arguments at runtime | -| dependencies | object dependencies | Module dependencies | -| description | string | Short description of the module +| crdb | CRDB object | CRDB-related information about the module
CRDB object fields:
**supported_featureset_versions**: array of integers | +| dependencies | dependencies object | Module dependencies | +| description | string | Short description of the module | | display_name | string | Name of module for display purposes | | email | string | Author's email address | | homepage | string | Module's homepage | | is_bundled | boolean | Whether module came bundled with a version of Redis Enterprise | -| license | string | Module is distributed under this license +| license | string | Module is distributed under this license | | min_redis_pack_version | string | Minimum Redis Enterprise Software cluster version required by this module | | min_redis_version | string | Minimum Redis database version required by this module | | module_file | string | Module filename | -| module_name | `search`
`ReJSON`
`graph`
`timeseries`
`bf` | Module's name
| -| os | string | Operating system used to compile the module | -| os_list | array of strings | List of supported operating systems | +| module_name | string | Module's name
Values:
`search`
`ReJSON`
`graph`
`timeseries`
`bf` | +| platforms | platforms object | Mapping operating system and architecture to module information (read-only) | | semantic_version | string | Module's semantic version | -| sha256 | string | SHA256 of module binary | +| sha256 | string | SHA256 of module binary (deprecated) | | version | integer | Module's version | diff --git a/content/operate/rs/7.4/references/rest-api/objects/module_metadata.md b/content/operate/rs/7.4/references/rest-api/objects/module_metadata.md new file mode 100644 index 0000000000..0b13c4d03b --- /dev/null +++ b/content/operate/rs/7.4/references/rest-api/objects/module_metadata.md @@ -0,0 +1,38 @@ +--- +Title: Module metadata object +alwaysopen: false +categories: +- docs +- operate +- rs +description: An object that represents Redis module metadata +linkTitle: module_metadata +weight: $weight +url: '/operate/rs/7.4/references/rest-api/objects/module_metadata/' +--- + +Represents a [Redis module]({{< relref "/operate/oss_and_stack/stack-with-enterprise" >}}). + +| Name | Type/Value | Description | +|------|------------|-------------| +| uid | string | Cluster unique ID of module | +| architecture | string | Module was compiled under this architecture | +| author | string | Module creator | +| capabilities | array of strings | List of capabilities supported by this module | +| capability_name | string | Short description of module functionality | +| command_line_args | string | Command-line arguments passed to the module | +| config_command | string | Name of command to configure module arguments at runtime | +| crdb | CRDB object | CRDB-related information about the module
CRDB object fields:
**name**: string
**supported_featureset_versions**: array of integers | +| dependencies | dependencies object | Module dependencies | +| description | string | Short description of the module | +| display_name | string | Name of module for display purposes | +| email | string | Author's email address | +| homepage | string | Module's homepage | +| license | string | Module is distributed under this license | +| min_redis_pack_version | string | Minimum Redis Enterprise Software cluster version required by this module | +| min_redis_version | string | Minimum Redis database version required by this module | +| module_file | string | Module filename | +| module_name | string | Module's name | +| semantic_version | string | Module's semantic version | +| sha256 | string | SHA256 of module binary | +| version | integer | Module's version | diff --git a/content/operate/rs/7.8/references/rest-api/objects/module.md b/content/operate/rs/7.8/references/rest-api/objects/module.md index 491c510b43..527ba91957 100644 --- a/content/operate/rs/7.8/references/rest-api/objects/module.md +++ b/content/operate/rs/7.8/references/rest-api/objects/module.md @@ -16,26 +16,25 @@ Represents a [Redis module]({{< relref "/operate/oss_and_stack/stack-with-enterp | Name | Type/Value | Description | |------|------------|-------------| | uid | string | Cluster unique ID of module | -| architecture | string | Architecture used to compile the module | | author | string | Module creator | | capabilities | array of strings | List of capabilities supported by this module | | capability_name | string | Short description of module functionality | | command_line_args | string | Command line arguments passed to the module | | compatible_redis_version | string | Redis version required by this module | | config_command | string | Name of command to configure module arguments at runtime | -| dependencies | object dependencies | Module dependencies | -| description | string | Short description of the module +| crdb | CRDB object | CRDB-related information about the module
CRDB object fields:
**supported_featureset_versions**: array of integers | +| dependencies | dependencies object | Module dependencies | +| description | string | Short description of the module | | display_name | string | Name of module for display purposes | | email | string | Author's email address | | homepage | string | Module's homepage | | is_bundled | boolean | Whether module came bundled with a version of Redis Enterprise | -| license | string | Module is distributed under this license +| license | string | Module is distributed under this license | | min_redis_pack_version | string | Minimum Redis Enterprise Software cluster version required by this module | | min_redis_version | string | Minimum Redis database version required by this module. Only relevant for Redis databases earlier than v7.4. | | module_file | string | Module filename | -| module_name | `search`
`ReJSON`
`graph`
`timeseries`
`bf` | Module's name
| -| os | string | Operating system used to compile the module | -| os_list | array of strings | List of supported operating systems | +| module_name | string | Module's name
Values:
`search`
`ReJSON`
`graph`
`timeseries`
`bf` | +| platforms | platforms object | Mapping operating system and architecture to module information (read-only) | | semantic_version | string | Module's semantic version | -| sha256 | string | SHA256 of module binary | +| sha256 | string | SHA256 of module binary (deprecated) | | version | integer | Module's version | diff --git a/content/operate/rs/7.8/references/rest-api/objects/module_metadata.md b/content/operate/rs/7.8/references/rest-api/objects/module_metadata.md new file mode 100644 index 0000000000..87ca04adc9 --- /dev/null +++ b/content/operate/rs/7.8/references/rest-api/objects/module_metadata.md @@ -0,0 +1,39 @@ +--- +Title: Module metadata object +alwaysopen: false +categories: +- docs +- operate +- rs +description: An object that represents Redis module metadata +linkTitle: module_metadata +weight: $weight +url: '/operate/rs/7.8/references/rest-api/objects/module_metadata/' +--- + +Represents a [Redis module]({{< relref "/operate/oss_and_stack/stack-with-enterprise" >}}). + +| Name | Type/Value | Description | +|------|------------|-------------| +| uid | string | Cluster unique ID of module | +| architecture | string | Module was compiled under this architecture | +| author | string | Module creator | +| capabilities | array of strings | List of capabilities supported by this module | +| capability_name | string | Short description of module functionality | +| command_line_args | string | Command-line arguments passed to the module | +| compatible_redis_version | string | Redis version required by this module | +| config_command | string | Name of command to configure module arguments at runtime | +| crdb | CRDB object | CRDB-related information about the module
CRDB object fields:
**name**: string
**supported_featureset_versions**: array of integers | +| dependencies | dependencies object | Module dependencies | +| description | string | Short description of the module | +| display_name | string | Name of module for display purposes | +| email | string | Author's email address | +| homepage | string | Module's homepage | +| license | string | Module is distributed under this license | +| min_redis_pack_version | string | Minimum Redis Enterprise Software cluster version required by this module | +| min_redis_version | string | Minimum Redis database version required by this module. Only relevant for Redis databases earlier than v7.4. | +| module_file | string | Module filename | +| module_name | string | Module's name | +| semantic_version | string | Module's semantic version | +| sha256 | string | SHA256 of module binary | +| version | integer | Module's version | diff --git a/content/operate/rs/references/rest-api/objects/module.md b/content/operate/rs/references/rest-api/objects/module.md index bff829b52b..5137031d6e 100644 --- a/content/operate/rs/references/rest-api/objects/module.md +++ b/content/operate/rs/references/rest-api/objects/module.md @@ -15,26 +15,26 @@ Represents a [Redis module]({{< relref "/operate/oss_and_stack/stack-with-enterp | Name | Type/Value | Description | |------|------------|-------------| | uid | string | Cluster unique ID of module | -| architecture | string | Architecture used to compile the module | | author | string | Module creator | +| bigstore_version_2_support | boolean (default: false) | Whether the module supports bigstore_version_2 capability, bypassing capability validation (optional) | | capabilities | array of strings | List of capabilities supported by this module | | capability_name | string | Short description of module functionality | | command_line_args | string | Command line arguments passed to the module | | compatible_redis_version | string | Redis version required by this module | | config_command | string | Name of command to configure module arguments at runtime | -| dependencies | object dependencies | Module dependencies | -| description | string | Short description of the module +| crdb | CRDB object | CRDB-related information about the module
CRDB object fields:
**supported_featureset_versions**: array of integers | +| dependencies | dependencies object | Module dependencies | +| description | string | Short description of the module | | display_name | string | Name of module for display purposes | | email | string | Author's email address | | homepage | string | Module's homepage | | is_bundled | boolean | Whether module came bundled with a version of Redis Enterprise | -| license | string | Module is distributed under this license +| license | string | Module is distributed under this license | | min_redis_pack_version | string | Minimum Redis Enterprise Software cluster version required by this module | | min_redis_version | string | Minimum Redis database version required by this module. Only relevant for Redis databases earlier than v7.4. | | module_file | string | Module filename | -| module_name | `search`
`ReJSON`
`graph`
`timeseries`
`bf` | Module's name
| -| os | string | Operating system used to compile the module | -| os_list | array of strings | List of supported operating systems | +| module_name | string | Module's name
Values:
`search`
`ReJSON`
`timeseries`
`bf` | +| platforms | platforms object | Mapping operating system and architecture to module information (read-only) | | semantic_version | string | Module's semantic version | -| sha256 | string | SHA256 of module binary | +| sha256 | string | SHA256 of module binary (deprecated) | | version | integer | Module's version | diff --git a/content/operate/rs/references/rest-api/objects/module_metadata.md b/content/operate/rs/references/rest-api/objects/module_metadata.md new file mode 100644 index 0000000000..df4026bb2b --- /dev/null +++ b/content/operate/rs/references/rest-api/objects/module_metadata.md @@ -0,0 +1,39 @@ +--- +Title: Module metadata object +alwaysopen: false +categories: +- docs +- operate +- rs +description: An object that represents Redis module metadata +linkTitle: module_metadata +weight: $weight +--- + +Represents a [Redis module]({{< relref "/operate/oss_and_stack/stack-with-enterprise" >}}). + +| Name | Type/Value | Description | +|------|------------|-------------| +| uid | string | Cluster unique ID of module | +| architecture | string | Module was compiled under this architecture | +| author | string | Module creator | +| bigstore_version_2_support | boolean (default: false) | Whether the module supports bigstore_version_2 capability, bypassing capability validation (optional) | +| capabilities | array of strings | List of capabilities supported by this module | +| capability_name | string | Short description of module functionality | +| command_line_args | string | Command-line arguments passed to the module | +| compatible_redis_version | string | Redis version required by this module | +| config_command | string | Name of command to configure module arguments at runtime | +| crdb | CRDB object | CRDB-related information about the module
CRDB object fields:
**name**: string
**supported_featureset_versions**: array of integers | +| dependencies | dependencies object | Module dependencies | +| description | string | Short description of the module | +| display_name | string | Name of module for display purposes | +| email | string | Author's email address | +| homepage | string | Module's homepage | +| license | string | Module is distributed under this license | +| min_redis_pack_version | string | Minimum Redis Enterprise Software cluster version required by this module | +| min_redis_version | string | Minimum Redis database version required by this module. Only relevant for Redis databases earlier than v7.4. | +| module_file | string | Module filename | +| module_name | string | Module's name | +| semantic_version | string | Module's semantic version | +| sha256 | string | SHA256 of module binary | +| version | integer | Module's version |