Skip to content

Commit 7292ff4

Browse files
rrelledgerrelledge
committed
DOC-5688 Fixed RS 7.8 REST API object references for module and module_metadata
1 parent 8b798f6 commit 7292ff4

File tree

3 files changed

+47
-9
lines changed

3 files changed

+47
-9
lines changed

‎content/operate/rs/7.8/references/rest-api/objects/module.md‎

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -16,26 +16,25 @@ Represents a [Redis module]({{< relref "/operate/oss_and_stack/stack-with-enterp
1616
| Name | Type/Value | Description |
1717
|------|------------|-------------|
1818
| uid | string | Cluster unique ID of module |
19-
| architecture | string | Architecture used to compile the module |
2019
| author | string | Module creator |
2120
| capabilities | array of strings | List of capabilities supported by this module |
2221
| capability_name | string | Short description of module functionality |
2322
| command_line_args | string | Command line arguments passed to the module |
2423
| compatible_redis_version | string | Redis version required by this module |
2524
| config_command | string | Name of command to configure module arguments at runtime |
26-
| dependencies | object dependencies | Module dependencies |
27-
| description | string | Short description of the module
25+
| crdb | CRDB object | CRDB-related information about the module<br />CRDB object fields:<br />**supported_featureset_versions**: array of integers |
26+
| dependencies | dependencies object | Module dependencies |
27+
| description | string | Short description of the module |
2828
| display_name | string | Name of module for display purposes |
2929
| email | string | Author's email address |
3030
| homepage | string | Module's homepage |
3131
| is_bundled | boolean | Whether module came bundled with a version of Redis Enterprise |
32-
| license | string | Module is distributed under this license
32+
| license | string | Module is distributed under this license |
3333
| min_redis_pack_version | string | Minimum Redis Enterprise Software cluster version required by this module |
3434
| min_redis_version | string | Minimum Redis database version required by this module. Only relevant for Redis databases earlier than v7.4. |
3535
| module_file | string | Module filename |
36-
| module_name | `search`<br />`ReJSON`<br />`graph`<br />`timeseries`<br />`bf` | Module's name<br/> |
37-
| os | string | Operating system used to compile the module |
38-
| os_list | array of strings | List of supported operating systems |
36+
| module_name | string | Module's name<br />Values:<br />`search`<br />`ReJSON`<br />`graph`<br />`timeseries`<br />`bf` |
37+
| platforms | platforms object | Mapping operating system and architecture to module information (read-only) |
3938
| semantic_version | string | Module's semantic version |
40-
| sha256 | string | SHA256 of module binary |
39+
| sha256 | string | SHA256 of module binary (deprecated) |
4140
| version | integer | Module's version |

‎content/operate/rs/7.8/references/rest-api/objects/module_metadata.md‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
Title: Module metadata object
3+
alwaysopen: false
4+
categories:
5+
- docs
6+
- operate
7+
- rs
8+
description: An object that represents a Redis module metadata
9+
linkTitle: module_metadata
10+
weight: $weight
11+
url: '/operate/rs/7.8/references/rest-api/objects/module_metadata/'
12+
---
13+
14+
Represents a [Redis module]({{< relref "/operate/oss_and_stack/stack-with-enterprise" >}}).
15+
16+
| Name | Type/Value | Description |
17+
|------|------------|-------------|
18+
| uid | string | Cluster unique ID of module |
19+
| architecture | string | Module was compiled under this architecture |
20+
| author | string | Module's creator |
21+
| capabilities | array of strings | List of capabilities supported by this module |
22+
| capability_name | string | Short description of module functionality |
23+
| command_line_args | string | Command-line arguments passed to the module |
24+
| compatible_redis_version | string | Redis version required by this module |
25+
| config_command | string | Name of command to configure module arguments at runtime |
26+
| crdb | CRDB object | CRDB-related information about the module<br />CRDB object fields:<br />**name**: string<br />**supported_featureset_versions**: array of integers |
27+
| dependencies | dependencies object | Module dependencies |
28+
| description | string | Short description of the module |
29+
| display_name | string | Name of module for display purposes |
30+
| email | string | Author's email address |
31+
| homepage | string | Module's homepage |
32+
| license | string | Module is distributed under this license |
33+
| min_redis_pack_version | string | Minimum Redis Enterprise Software cluster version required by this module |
34+
| min_redis_version | string | Minimum Redis database version required by this module. Only relevant for Redis databases earlier than v7.4. |
35+
| module_file | string | Module filename |
36+
| module_name | string | Module's name |
37+
| semantic_version | string | Module's semantic version |
38+
| sha256 | string | SHA256 of module binary |
39+
| version | integer | Module's version |

‎content/operate/rs/references/rest-api/objects/module_metadata.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Represents a [Redis module]({{< relref "/operate/oss_and_stack/stack-with-enterp
2020
| bigstore_version_2_support | boolean (default: false) | Whether the module supports bigstore_version_2 capability, bypassing capability validation (optional) |
2121
| capabilities | array of strings | List of capabilities supported by this module |
2222
| capability_name | string | Short description of module functionality |
23-
| command_line_args | string | Command line arguments passed to the module |
23+
| command_line_args | string | Command-line arguments passed to the module |
2424
| compatible_redis_version | string | Redis version required by this module |
2525
| config_command | string | Name of command to configure module arguments at runtime |
2626
| crdb | CRDB object | CRDB-related information about the module<br />CRDB object fields:<br />**name**: string<br />**supported_featureset_versions**: array of integers |

0 commit comments

Comments
 (0)