diff options
| author |   david.mcweeney <david.mcweeney@est.tech> | 2024-01-04 12:29:33 +0000 |
|---|---|---|
| committer | david.mcweeney <david.mcweeney@est.tech> | 2024-01-05 10:02:26 +0000 |
| commit | deee6fff07452d230a4599eb136bded69d4cb595 (patch) | |
| tree | bbe749082c85e783e7bc8c69e3854671e1c5746f /docs | |
| parent | 7e94b26a666907cc97d692b8dda8364bb0a0ef45 (diff) | |
Amend http status for CM Handles Data Enpoints in Documentation
Change-Id: I4b2778e9e1107fc2934df292bee99d36030c8093
Signed-off-by: david.mcweeney <david.mcweeney@est.tech>
Issue-ID: CPS-1998
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/ncmp-data-operation.rst | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/docs/ncmp-data-operation.rst b/docs/ncmp-data-operation.rst index 617b3ed309..94d5ee9c0a 100644 --- a/docs/ncmp-data-operation.rst +++ b/docs/ncmp-data-operation.rst @@ -6,8 +6,8 @@ .. _cmHandleDataOperation: -CM Handles Data Operation Endpoints -################################### +Data Operations Endpoint +######################## .. toctree:: :maxdepth: 1 @@ -15,11 +15,11 @@ CM Handles Data Operation Endpoints Introduction ============ -For data operation CM Handles we have a Post endpoints: +For all data operations on cm handle(s), we have a post endpoint: - /ncmp/v1/data?topic={client-topic-name} forward request to it's dmi plugin service. -- Returns request id (UUID) with http status 202. +- When asynchronous (with topic) operations are executed, a request id (UUID) will be returned. Request Body ============ @@ -143,6 +143,6 @@ DMI Service 2 (POST) : `http://{dmi-host-name}:{dmi-port}/dmi/v1/data?topic=my-t } ] -Above examples are for illustration purpose only please refer link below for latest schema. +Above examples are for illustration purposes only. Please refer to link below for latest schema. :download:`Data operation event schema <schemas/data-operation-event-schema-1.0.0.json>`
\ No newline at end of file |