Add global description 66/107466/6
authorlubos-cicut <lubos.cicut@pantheon.tech>
Tue, 22 Aug 2023 05:34:22 +0000 (07:34 +0200)
committerIvan Hrasko <ivan.hrasko@pantheon.tech>
Fri, 25 Aug 2023 13:36:30 +0000 (13:36 +0000)
commit4b6efb9dcb316623df2dffda1aedef56f456ce6b
tree2ecdd7c43b1c910cb2aadd155b07c0b4d0464964
parent618c221ebd47a95f9cb2f749f0fcc68baa2fc983
Add global description

Add global description (info/description) to OpenApi that
states that we are providing full API for configurational
data because only those can be edited (by POST, PUT, PATCH,
DELETE) and for operational we only provide GET API.

In addition, for majority of request user can see only
config data in examples. That’s because we can show only one
example per request.

The exception when user can see operational data in example
is when data are representing operational (config false)
container with no config data in it.

JIRA: NETCONF-1138
Change-Id: I5c9de0c8780289f4557c7ce9995b8cb5d44e0290
Signed-off-by: lubos-cicut <lubos.cicut@pantheon.tech>
restconf/restconf-openapi/src/main/java/org/opendaylight/restconf/openapi/impl/BaseYangOpenApiGenerator.java
restconf/restconf-openapi/src/main/java/org/opendaylight/restconf/openapi/model/Info.java
restconf/restconf-openapi/src/main/java/org/opendaylight/restconf/openapi/mountpoints/MountPointOpenApi.java