diff options
| author |   lapentafd <francesco.lapenta@est.tech> | 2023-03-27 13:46:04 +0100 |
|---|---|---|
| committer | Francesco Davide Lapenta <francesco.lapenta@est.tech> | 2023-04-04 14:31:45 +0000 |
| commit | a43eb545dded63e1f21b7f14105ae0ed093b54db (patch) | |
| tree | 54d965ae22f9ed6c39a2d978632ecb0158c3ca16 /docs/clamp | |
| parent | a174cadc174377c9c38df860d7e37b5799067bc7 (diff) | |
Update Policy Offered APIs
Swagger documentation rendered in ReDoc webpage.
The html page is generated during the Sphinx build.
The sphinx.builders.linkcheck reports as false positives
the links that are generated dynamically, such as with the sphinxcontrib-redoc extension.
Issue-ID: POLICY-4581
Change-Id: I9b720b961332689b144d5fe9d8be82be436d1c16
Signed-off-by: lapentafd <francesco.lapenta@est.tech>
Diffstat (limited to 'docs/clamp')
| -rw-r--r-- | docs/clamp/acm/api-protocol/acm-rest-apis.rst | 19 |
1 files changed, 16 insertions, 3 deletions
diff --git a/docs/clamp/acm/api-protocol/acm-rest-apis.rst b/docs/clamp/acm/api-protocol/acm-rest-apis.rst index 19c2a01a..1770c756 100644 --- a/docs/clamp/acm/api-protocol/acm-rest-apis.rst +++ b/docs/clamp/acm/api-protocol/acm-rest-apis.rst @@ -19,7 +19,11 @@ reference to the Automation Composition Type. The incoming TOSCA is verified and referential integrity. On delete requests, a check is made to ensure that no Automation Composition Instances exist for the Automation Composition Type to be deleted. -.. swaggerv2doc:: swagger/acm-comissioning.json +.. csv-table:: + :header: "Commissioning API" + :widths: 10 + + `ACM-R Commissioning Swagger <./local-swagger.html#tag/Automation-Composition-Definition>`_ Instantiation API @@ -45,7 +49,11 @@ A call to the update endpoint for a Automation Composition Instance follows the here: :ref:`4.1 Management of Automation Composition Instance Configurations <management-acm-instance-configs>`. -.. swaggerv2doc:: swagger/acm-instantiation.json +.. csv-table:: + :header: "Instantiation API" + :widths: 10 + + `ACM-R Instantiation Swagger <./local-swagger.html#tag/Automation-Composition-Instance>`_ Instantiation Automation Composition Instance Lifecycle Management @@ -88,7 +96,12 @@ GUI. The API provides filtering so that specific Participants and Automation Com can be retrieved. In addition, the quantity of statistical information to be returned can be scoped. -.. swaggerv2doc:: swagger/acm-monitoring.json +.. csv-table:: + :header: "Monitoring API" + :widths: 10 + + `ACM-R Monitoring Swagger <./local-swagger.html#tag/Participant-Monitoring>`_ + Pass Through API ================ |