[NETCONF-1138] OpenApi: Add global description Created: 17/Aug/23  Updated: 25/Aug/23  Resolved: 25/Aug/23

Status: Resolved
Project: netconf
Component/s: restconf-openapi
Affects Version/s: None
Fix Version/s: 7.0.0

Type: Task Priority: Medium
Reporter: Ivan Hrasko Assignee: Ľuboš Čičut
Resolution: Done Votes: 0
Labels: pt
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified


 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.


Generated at Wed Feb 07 20:16:46 UTC 2024 using Jira 8.20.10#820010-sha1:ace47f9899e9ee25d7157d59aa17ab06aee30d3d.