docs: integrate onvif schemas and validation matrix to swagger

[ajcasagrande]

Lots of additional changes/improvements to the swagger generation:

• Link json schemas converted from wsdl to the corresponding endpoints in the swagger file
• Cleanup and fix response types and include base types from core-command service
• For GET calls with jsonObject field, provide documentation on the format and schema of the field, along with descriptions of each field.
• Parse the tested onvif cameras validation matrix and insert it (footnotes and all) into the description of each linked command
• Add useful warning messages during generation if some commands are missing required or optional data
• Switch to ruamel.yaml to allow multi-line strings to support Markdown sytanx for description fields.
• Remove unused schema definitions from onvif wsdl
• Auto generate documentation for base64 env vars

PR Checklist

Please check if your PR fulfills the following requirements:

• I am not introducing a breaking change (if you are, flag in conventional commit message with BREAKING CHANGE: describing the break)
• I am not introducing a new dependency (add notes below if you are)
• [N/A] I have added unit tests for the new feature or bug fix (if not, why?)
• I have fully tested (add details below) this the new feature or bug fix (if not, why?)
• I have opened a PR for the related docs change (if not, why?)

Testing Instructions

Browse the hosted version:
https://app.swaggerhub.com/apis-docs/ANTHONYJINTEL/edge-x_onvif_device_service/2.2.0

New Dependency Instructions (If applicable)

Note: these dependencies are only used for the purpose of generating the OpenAPI 3.0 swagger file.

JavaScript:

• postman-to-openapi

Python:

• PyYAML
• ruamel.yaml

---

A few example screenshots:

jsonObject schema:

tested cameras matrix:

response event/object schemas:

[codecov-commenter]

Codecov Report

Merging #180 (c44d1cb) into main (c32d12c) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #180   +/-   ##
=======================================
  Coverage   30.82%   30.82%           
=======================================
  Files          18       18           
  Lines        1810     1810           
=======================================
  Hits          558      558           
  Misses       1187     1187           
  Partials       65       65           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

[brianointel]

Looks good!

[ChristianDarr-personal]

I'm still looking through this, but I think that are too many output statements. Maybe an option to disable it or just removing some of the more extraneous ones would be mote helpful.

[ajcasagrande]

I'm still looking through this, but I think that are too many output statements. Maybe an option to disable it or just removing some of the more extraneous ones would be mote helpful.

@ChristianDarr-personal I agree. The prints were helpful when creating the scripts, but now they are just noise. I have switched to using the python logging package and have set a majority of them as debug. By default they are off, but can be enabled by doing DEBUG_LOGGING=1 make ....