Start OpenAPI spec, for #17

reconciliation-api / specs

Specifications of the reconciliation API

30 stars 9 forks source link

Open wetneb opened 2 months ago

wetneb commented 2 months ago

This is a draft of an OpenAPI spec, for #17.

Remaining things to address:

[ ] the schemas we have are JSON Schemas, but OpenAPI needs "OpenAPI Schema Objects" instead, so we'd need to (ideally automatically) convert our schemas to that
[ ] include expected behaviour on invalid input (#171)
[ ] link to the OpenAPI profile from the HTML specs (or include it verbatim even?)

netlify[bot] commented 2 months ago

Name	Link
Latest commit	869478353e2833e9e1b9aff09886a549c0eef760
Latest deploy log	https://app.netlify.com/sites/reconciliation-api-specs/deploys/66698e759a12df00080b2a3c
Deploy Preview	https://deploy-preview-172--reconciliation-api-specs.netlify.app
Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.