Skip to content

Commit 1429ae7

Browse files
committed
DOC-5680 Copy edits for user-defined modules REST API requests reference
1 parent d1dcaa3 commit 1429ae7

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

content/operate/rs/references/rest-api/requests/modules/user-defined.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@ weight: $weight
1414
| Method | Path | Description |
1515
|--------|------|-------------|
1616
| [GET](#get-local-user-defined-artifacts) | /v2/local/modules/user-defined/artifacts | List custom module artifacts on a node |
17-
| [POST](#post-user-defined-module) | /v2/modules/user-defined | Create a custom module object in the CCS |
17+
| [POST](#post-user-defined-module) | /v2/modules/user-defined | Upload custom module configuration |
1818
| [POST](#post-local-user-defined-artifacts) | /v2/local/modules/user-defined/artifacts | Upload a custom module artifact to a node |
19-
| [DELETE](#delete-user-defined-module) | /v2/modules/user-defined/<uid> | Delete a custom module object from the CCS |
19+
| [DELETE](#delete-user-defined-module) | /v2/modules/user-defined/<uid> | Delete a custom module configuration |
2020
| [DELETE](#delete-local-user-defined-artifacts) | /v2/local/modules/user-defined/artifacts/<module_name>/<version> | Delete a custom module artifact from a node |
2121

2222
## List custom module artifacts {#get-local-user-defined-artifacts}
@@ -73,13 +73,13 @@ Returns a JSON array of custom module artifacts.
7373
|------|-------------|
7474
| [200 OK](https://www.rfc-editor.org/rfc/rfc9110.html#name-200-ok) | Success, returns list of artifacts |
7575

76-
## Create custom module {#post-user-defined-module}
76+
## Upload custom module configuration {#post-user-defined-module}
7777

7878
```sh
7979
POST /v2/modules/user-defined
8080
```
8181

82-
Creates a module object in the CCS. After calling this endpoint, you still need to upload the module's `.so` file to each node by calling [`POST /v2/local/modules/user-defined/artifacts`](#post-local-user-defined-artifacts) on each node.
82+
Creates a module object in the cluster configuration store (CCS). After calling this endpoint, you still need to upload the module's `.so` file to each node by calling [`POST /v2/local/modules/user-defined/artifacts`](#post-local-user-defined-artifacts) on each node.
8383

8484
#### Permissions
8585

@@ -212,7 +212,7 @@ Returns a status code to indicate upload success or failure.
212212
DELETE /v2/modules/user-defined/{string: uid}
213213
```
214214

215-
Delete a module object from the CCS. This REST API request does not delete the module artifact from the nodes, so you also need to call [`DELETE /v2/local/modules/user-defined/artifacts/<module_name>/<version>`](#delete-local-user-defined-artifacts) on each node.
215+
Delete a module object from the cluster configuration store (CCS). This REST API request does not delete the module artifact from the nodes, so you also need to call [`DELETE /v2/local/modules/user-defined/artifacts/<module_name>/<version>`](#delete-local-user-defined-artifacts) on each node.
216216

217217
#### Permissions
218218

0 commit comments

Comments
 (0)