[TRNSPRTPCE-534] Reintroduce Swagger in TransportPCE as a feature Created: 30/Sep/21  Updated: 22/Oct/21  Resolved: 22/Oct/21

Status: Verified
Project: transportpce
Component/s: None
Affects Version/s: None
Fix Version/s: Phosphorus

Type: Improvement Priority: Medium
Reporter: Gilles Thouenon Assignee: Guillaume Lambert
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: 0 minutes
Time Spent: 4 hours
Original Estimate: Not Specified

Issue Links:
Relates
relates to TRNSPRTPCE-545 Swagger does not work properly with h... Resolved

 Description   

odl-restconf-all has been replaced by simply odl-restconf in TPCE dependencies since this second dependency is enough to run the controller

cf https://git.opendaylight.org/gerrit/c/transportpce/+/96668

As a consequence swagger/apidoc is no longer installed along TransportPCE.

Swagger is a convenient way to expose and use graphically RESTCONF API available in the OpenDaylight controller.
A dedicated feature not activated by default would allow to reactive swagger when necessary.



 Comments   
Comment by Olivier Renais [ 30/Sep/21 ]

Sorry but I don't see why I am assigned on this.
To me, this is a major regression that must be adressed as soon as possible. The API doc is not decorative and something nice to have, it is needed for debugging and used quite commonly in all our demonstration

Comment by Guillaume Lambert [ 07/Oct/21 ]

I haven't understood why I was assigned to it too.
This was not discussed during Sprint Planning so you need to be warned as a PO and I can't add you as a simple watcher...
In my opinion, every developper should know how to declare such features. If not, I'd be happy to explain it.

Anyway, I've reassigned it to me and I've finished the job to create a separate feature in 97690 PS2.

Note there is no point to declare this new feature in integration/distribution.
Swagger can already be installed in official packages since it is inherited from netconf.
Thus it is still present in official distros.
If I agree it is problematic for people donwloading and debugging code base,
the term "major regression" is improper here IMO for this reason and also because  it is not really a tpce feature.

I modified the initial description not to say it is decorative but because we do not strictly need it to run the controller.
Separating the minium set of vital dependencies from optional ones is a common best practice.
Eventually the controller now works but swagger still not. It raises warnings after installation when trying to parse an ospf model.
I filled a bug in https://jira.opendaylight.org/browse/TRNSPRTPCE-545 for more details.
That's the best I can do at this stage.

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