Remove need for separate ReSpec clone for Arazzo - Githubissues

OAI / Arazzo-Specification

The Arazzo Specification - A Tapestry for Deterministic API Workflows

https://spec.openapis.org/arazzo/latest.html

Apache License 2.0

224 stars 44 forks source link

Remove need for separate ReSpec clone for Arazzo #212

Closed ralfhandl closed 4 months ago

ralfhandl commented 4 months ago

Use the same OAI fork of ReSpec as the OpenAPI specification and set section headline for "abstract" in the HTML document instead of tweaking the default in the respec-xxx.js

ralfhandl commented 4 months ago

@frankkilcommins Please review

frankkilcommins commented 4 months ago

@ralfhandl can you share the related OpenAPI-Specification/gh-pages commit?

ralfhandl commented 4 months ago

Not yet merged, PR https://github.com/OAI/OpenAPI-Specification/pull/3943 is still waiting for @darrelmiller's approval.

Easiest way to test this:

check out this PR
bash scripts/md2html/build.sh
copy https://github.com/OAI/OpenAPI-Specification/blob/gh-pages/js/respec-oai.js to deploy/js and make sure it is the only file there
verify that your local file structure is
open deploy/arazzo/latest.html in browser
verify that the first headline after the Copyright line is "What is the Arazzo Specification?"

No need for a modified respec-arazzo.js.

ralfhandl commented 4 months ago

OAS is moving to the latest unmodified ReSpec with static HTML pages that do not need a respec-*.js.

See https://github.com/OAI/OpenAPI-Specification/pull/3944