@cloudflare/json-schema-apidoc-loader

0.1.2 • Public • Published

JSON Schema API Documentation Loader

Webpack loader that uses @cloudflare/json-schema-transform to convert JSON Hyper-Schema documents that do not have $refs into a form suitable for generating human-readable API documentation.

The resulting schemas validate the same set of instances as the input schemas, but simplify the structure as much as possible. Additionally, the example and cfCurl fields contain example values that documentation UIs can display.

Readme

Keywords

none

Package Sidebar

Install

npm i @cloudflare/json-schema-apidoc-loader

Weekly Downloads

1,009

Version

0.1.2

License

BSD-3-Clause

Unpacked Size

2.11 kB

Total Files

3

Last publish

Collaborators

  • lerwincf
  • lbarthonet
  • cf-media-manager
  • jacobbednarz
  • celso
  • cf-radar
  • dash_service_account
  • g4brym
  • snigdha34
  • wrangler-publisher
  • marksteyn
  • chiminator
  • sgoodhew_cf
  • terinjokes
  • third774
  • jsteinberger
  • jasnell
  • asapzacy
  • pcostanzo
  • gregbrimble
  • geelen
  • rexscaria
  • dcruz_cf
  • xuranwang
  • jculvey
  • sejoker
  • vasturiano
  • cf-ci-write
  • segments-write
  • thibmeu
  • xortive
  • gurjinder
  • cf-ci2
  • lvalenta
  • worenga