ReSpec extensions

The Verifiable Credentials API[1] group wants their normative definitions to
be expressed using the Open API Specification (OAS)[2], which uses .yaml to
mark up things about HTTP-based APIs.

I have hacked together the start of an oas-render[3] "plugin?" for ReSpec to
transclude parts of OAS files into ReSpec, so that humans can read them. It's
effectively a ReSpec renderer for OAS files, example here:

https://w3c-ccg.github.io/vc-api/#issue-credential

It needs a lot of work, but before the VC-API group does that work, I wanted
to see if there are any best practices when creating respec plugins? I looked
through the respec docs but didn't find anything on extending ReSpec in this
way... or a location where the spec-prod community might want to put these
sorts of ReSpec plugins/extensions?

-- manu

[1] https://w3c-ccg.github.io/vc-api/
[2] https://swagger.io/specification/
[3] https://github.com/w3c-ccg/vc-api/blob/main/common.js#L404-L423

-- 
Manu Sporny - https://www.linkedin.com/in/manusporny/
Founder/CEO - Digital Bazaar, Inc.
News: Digital Bazaar Announces New Case Studies (2021)
https://www.digitalbazaar.com/

Received on Thursday, 4 November 2021 19:19:57 UTC