cloudflare / doca

A CLI tool that scaffolds API documentation based on JSON HyperSchemas.
BSD 3-Clause "New" or "Revised" License
228 stars 36 forks source link

Use URI Template syntax for URI templates #10

Closed handrews closed 6 years ago

handrews commented 7 years ago

Currently we're using a PHP-ish ":", but given that hyper-schema is written using RFC 6570 URI Templates we should stay consistent with that.

handrews commented 7 years ago

This will be simpler if json-schema-org/json-schema-spec#228 gets into draft 6, as it will no longer be necessary to inline JSON Pointers into the templates in order to assign a schema for input validation.

handrews commented 7 years ago

Let's do the following:

handrews commented 6 years ago

This set of packages is being deprecated in favor of the JSON Schema Tools monorepo. The new packages use URI Templates per RFC 6570.

The new UI is still being designed, but the back-end already fills out example curl requests using RFC 6570. Feel free to file at cloudflare/json-schema-tools if you want to track work related to this in the new UI specifically.