Swagger ws doc - Githubissues

cablelabs / transparent-security

Transparent Security is a solution for identify the source devices of a DDoS attack and mitigates the attack in the customer premises or the access network. This solution leverages a P4 based programmable data plane for add in-band network telemetry (INT) for device identification and in-band mitigation.

Apache License 2.0

32 stars 4 forks source link

What does this PR do?

Fixes #17 Adds the usage of the Python package flask-restful-swagger-3 so now the REST APIs will be published to http:{controller_ip}:9998/api/doc/swagger.json

Do you have any concerns with this PR?

How can the reviewer verify this PR?

Access the swagger info from the controller public IP on a browser. See complete URL above.

Any background context you want to provide?

This should reduce the MD we will need to write later.

Screenshots or logs (if appropriate)

Questions:

Have you connected this PR to the issue it resolves? yes
Does the documentation need an update? This one actually helps with our overall doc issues
Does this add new dependencies? Python - flask-restful-swagger-3 library
Have you added unit or functional tests for this PR? no