From 3d0aa333829644f0590b5064d68866da212ef717 Mon Sep 17 00:00:00 2001 From: elinuxhenrik Date: Wed, 8 Apr 2020 08:15:59 +0200 Subject: [PATCH] Adapt documentation to change in API The /services/keepalive method is changed to PUT: Update some descriptions. Change-Id: I35faa3a47ad8c19f6c0eadf069656626a1ddc428 Issue-ID: NONRTRIC-164 Signed-off-by: elinuxhenrik --- docs/index.rst | 5 ----- docs/policy-agent-api.rst | 17 ++++++++++------- 2 files changed, 10 insertions(+), 12 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index b499c095..d28ff498 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -5,8 +5,6 @@ Non-RT RIC ========== -.. Add or remove sections below as appropriate for the platform component. - .. toctree:: :maxdepth: 2 :caption: Contents: @@ -18,7 +16,4 @@ Non-RT RIC ./overview.rst ./release-notes.rst - -* :ref:`genindex` -* :ref:`modindex` * :ref:`search` diff --git a/docs/policy-agent-api.rst b/docs/policy-agent-api.rst index 8a46fc71..a65e6115 100644 --- a/docs/policy-agent-api.rst +++ b/docs/policy-agent-api.rst @@ -115,7 +115,7 @@ PUT Service created. 400: - Something went wrong with the service registration. + The ServiceRegistrationInfo is not accepted. **Examples:** @@ -243,8 +243,8 @@ DELETE /services/keepalive ~~~~~~~~~~~~~~~~~~~ -POST -++++ +PUT ++++ Heart beat from a service. @@ -268,7 +268,7 @@ POST Call: :: - curl -X POST "http://localhost:8081/services/keepalive?name=existing" + curl -X PUT "http://localhost:8081/services/keepalive?name=existing" Result: 200: :: @@ -277,7 +277,7 @@ POST Call: :: - curl -X POST "http://localhost:8081/services/keepalive?name=nonexistent" + curl -X PUT "http://localhost:8081/services/keepalive?name=nonexistent" Result: 404: :: @@ -741,7 +741,7 @@ PUT Near |nbh| RT |nbsp| RIC or policy type is not found. 423: - Near |nbh| RT |nbsp| RIC is locked. + Near |nbh| RT |nbsp| RIC is not operational. **Examples:** @@ -794,6 +794,9 @@ DELETE 404: Policy is not found. + 423: + Near |nbh| RT |nbsp| RIC is not operational. + **Examples:** Call: :: @@ -904,7 +907,7 @@ GET **Parameters:** - managedElementId: (*Optional*) + managedElementId: (*Required*) The ID of the Managed Element. **Responses:** -- 2.16.6