blob: 27bfdf958444b81e04c1ec8cf48927ff7b1c75eb [file] [log] [blame]
shivasubedi3d1579c2021-09-13 16:43:20 +01001.. This work is licensed under a Creative Commons Attribution 4.0 International License.
2.. http://creativecommons.org/licenses/by/4.0
halil.cakal0bdc9432023-09-12 15:32:53 +01003.. Copyright (C) 2021-2023 Nordix Foundation
shivasubedi3d1579c2021-09-13 16:43:20 +01004
5.. DO NOT CHANGE THIS LABEL FOR RELEASE NOTES - EVEN THOUGH IT GIVES A WARNING
6.. _design:
7
8
DylanB95EST7f1fa6d2021-10-11 16:33:29 +01009DMI-Plugin Design
shivasubedi3d1579c2021-09-13 16:43:20 +010010#################
11
shivasubedi3d1579c2021-09-13 16:43:20 +010012.. toctree::
13 :maxdepth: 1
14
15Offered APIs
16============
17
DylanB95EST7f1fa6d2021-10-11 16:33:29 +010018The DMI-Plugin supports the public APIs listed in the link below:
shivasubedi3d1579c2021-09-13 16:43:20 +010019
Renu Kumari3aea57e2021-10-12 13:41:01 -040020:download:`DMI Rest OpenApi Specification <api/swagger/openapi.yaml>`
shivasubedi3d1579c2021-09-13 16:43:20 +010021
lukegleeson78d59222021-10-01 17:21:48 +010022View Offered APIs
23-----------------
shivasubedi3d1579c2021-09-13 16:43:20 +010024
25The standard for API definition in the RESTful API world is the OpenAPI Specification (OAS).
26The OAS 3, which is based on the original "Swagger Specification", is being widely used in API developments.
27
28Specification can be accessed using following URI:
29
30.. code-block:: bash
31
lukegleeson78d59222021-10-01 17:21:48 +010032 http://<hostname>:<port>/v3/api-docs?group=dmi-plugin-docket
shivasubedi3d1579c2021-09-13 16:43:20 +010033
lukegleeson78d59222021-10-01 17:21:48 +010034Additionally, the Swagger User Interface can be found at the following URI. The component may be changed between CPS-Core
35and CPS-NCMP using the drop down table in the top right:
shivasubedi3d1579c2021-09-13 16:43:20 +010036
lukegleeson78d59222021-10-01 17:21:48 +010037.. code-block:: bash
38
39 http://<hostname>:<port>/swagger-ui/index.html?configUrl=/v3/api-docs/swagger-config#/
40
halil.cakal0bdc9432023-09-12 15:32:53 +010041Health Check APIs
42=================
43
44The healthcheck URL can be accessed using following URI:
45
46.. code-block:: bash
47
48 http://<hostname>:<port>/manage/health
49
50The Health check endpoint is essential for monitoring the status of DMI-Plugins.
51CPS is using a Spring Boot pattern here which can easily be configured for any spring boot application.
52Springboot provides a built-in Health Check feature through the Spring Boot Actuator module.
53
lukegleeson78d59222021-10-01 17:21:48 +010054Consumed APIs
55=============
56
57- SDNC: REST based interface exposed by the SDNC client. This is used to retrieve the yang resources and modules for CPS.