Publish OpenAPI YAML spec in CI/CD

[aaazzam]

Describe the current behavior

The OpenAPI YAML specification is not currently published, but can be inspected at runtime.

Describe the proposed behavior

It would be beneficial to automatically generate and publish our FastAPI OpenAPI specification in YAML format. This could be done on each successful merge to the main branch.

Potential steps:

• Convert the FastAPI().openapi() JSON to YAML format
• Choose an appropriate location to save the YAML file
• Consider integrating the process into the CI/CD pipeline for main branch merges

Benefits:

• Facilitates dynamic client/SDK creation in other languages
• Simplifies API versioning and change analysis
• Provides up-to-date API documentation

FastAPI already generates the OpenAPI spec. The main task would be exporting and publishing it in YAML format. This enhancement could improve the API's accessibility and ease of integration. Thoughts, suggestions, or volunteers to implement this are welcome!

Example Use

No response

Additional context

No response

[aaazzam]

I think it's literally this in CI/CD:

from prefect.server.api.server import create_app
import yaml

with open('openapi.yaml', 'w') as file:
    yaml.dump(create_app().openapi(), file)