Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Start OpenAPI spec, for #17 #172

Draft
wants to merge 13 commits into
base: master
Choose a base branch
from
Draft

Start OpenAPI spec, for #17 #172

wants to merge 13 commits into from

Conversation

wetneb
Copy link
Member

@wetneb wetneb commented Apr 12, 2024

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 (Clarify expected behaviour on invalid input #171)
  • link to the OpenAPI profile from the HTML specs (or include it verbatim even?)

Copy link

netlify bot commented Apr 12, 2024

Deploy Preview for reconciliation-api-specs ready!

Name Link
🔨 Latest commit 8694783
🔍 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...

QR Code

Use your smartphone camera to open QR code link.

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

@wetneb wetneb marked this pull request as draft April 12, 2024 11:52
@thadguidry thadguidry mentioned this pull request Jun 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants