Show Posts
1
Development and Code Review / Contributing OpenAPI documentation?
« on: July 11, 2023, 02:51:20 am »
Hi all,
I didn't want to make an issue on Github since this more of a discussion. I see there have been some past efforts in creating API clients and documenting endpoints here and here which gave rise to the current script that is used to generate the API documentation. I have also come across various other clients (Python), and plugins for IaC tools such as Ansible and Terraform, that all have their own shortcomings due to having to manually implement an API client.
I would love to see better integration with OPNsense in these areas, and I would be interested in adding more "proper" documentation server-side using OpenAPI annotations with a library like swagger-php. This would unlock the ability to easily create clients and integrations through the OpenAPI generator, and would remove the need to parse the PHP code to render the docs.
The real question is would the developers be open to such contributions?
I didn't want to make an issue on Github since this more of a discussion. I see there have been some past efforts in creating API clients and documenting endpoints here and here which gave rise to the current script that is used to generate the API documentation. I have also come across various other clients (Python), and plugins for IaC tools such as Ansible and Terraform, that all have their own shortcomings due to having to manually implement an API client.
I would love to see better integration with OPNsense in these areas, and I would be interested in adding more "proper" documentation server-side using OpenAPI annotations with a library like swagger-php. This would unlock the ability to easily create clients and integrations through the OpenAPI generator, and would remove the need to parse the PHP code to render the docs.
The real question is would the developers be open to such contributions?