Generate Swagger Files based on Device Profiles

[ajcasagrande]

🚀 Feature Request

Relevant Package [REQUIRED]

device-sdk or core-command

Description [REQUIRED]

I think it should be possible to generate a swagger file (OpenAPI spec) for the commands (and resources) listed in a device profile. It may not be able to know all of the options (such as the base64 encoded jsonObject for device-onvif-camera's GET calls), but would provide a way to let users explore the commands available for a specific device. This would be intended as a documentation enhancer for device services.

Describe the solution you'd like

Generate a swagger file for each device profile of a device service. In the future the device profile spec could even be amended to include helper or hint fields to enhance the generation process and provide better output swagger files.

Describe alternatives you've considered

• Writing by hand
• EdgeX-UI provides something similar I believe in the form of the command creation (afaik)