OAI / sig-moonwalk

Version 4.x of the OpenAPI Specification is known as "Moonwalk," and has a goal to ship in 2024.
https://www.openapis.org/blog/2023/12/06/openapi-moonwalk-2024
Apache License 2.0
278 stars 13 forks source link

PR to set up infra for publishing a respec version of moonwalk #132

Closed darrelmiller closed 3 months ago

darrelmiller commented 3 months ago

This PR includes some updates to the docs folder to enable publishing an "editors draft" to the GH pages site.

There is a script called Generate.ps1 that will take the files in the specification folder and generate a moonwalk.html file in the docs folder. It does rely on respec and powershell being installed to run it locally. However, it should all run via a GitHub Action whenever we commit to main. It would be nice to figure out how to create a rendered doc on a PR branch, but that is for another day.

The reason for doing things a bit differently than how they are done in the OpenAPI-Specification repo is that this uses pretty much stock respec. This gives us the ability to use all the fancy features of respec like building a TOC, linking to other specs, generating a bibliography and linking to GitHub issues.

I'm going to merge this to main. Don't take the content of the editors draft too seriously. The content is there more for making sure all the bits are working.