feat-openapi-spec-action

[colinwilliams91]

Describe the Problem

As a developer, I would like any modifications/updates to the openapi-spec.json file (which is used to build and serve API docs html page) to be piped into the deployed html docs view.

Describe the Proposed Solution

The pipeline should be as follows:

• eg.
  • create a new API endpoint
  • checkout openapi-sec branch
  • decorate API endpoint with appropriate JSDoc swagger comments
  • run a script that re-writes ./openapi-spec.json with updated API endpoint information(currently node server restart will achieve this)
  • push to a remote branch (like unity-assets branch that has an action watching it) that will push to deployed branch (main)
  • another action should pipe these changes to however swagger-ui-dist is serving/rendering the stylized documentation view

References

swagger-ui-dist docs

this section: