Skip to content

docs: add openapi examples for spike route - #1044

Merged
greatest0fallt1me merged 1 commit into
CalloraOrg:mainfrom
Tobiloba0:issue-911-openapi-spike-examples
Jul 29, 2026
Merged

docs: add openapi examples for spike route#1044
greatest0fallt1me merged 1 commit into
CalloraOrg:mainfrom
Tobiloba0:issue-911-openapi-spike-examples

Conversation

@Tobiloba0

Copy link
Copy Markdown

Closes #911

Summary

  • Add request/response examples for the public /api/spike timeout probe
  • Document spike record create, list, update, and delete examples
  • Add Spike OpenAPI component schemas and a focused YAML contract test

Testing

  • git diff --check
  • node -e "...OpenAPI spike examples smoke check..."

Notes

  • npm test -- --runInBand src/routes/spike.openapi.test.ts was blocked by the existing error-codes:check failure before Jest started.
  • Direct npx jest/npx eslint could not run because dependencies were not installed; npm ci timed out before local binaries were available.

@drips-wave

drips-wave Bot commented Jul 29, 2026

Copy link
Copy Markdown

@Tobiloba0 Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits.

You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀

Learn more about application limits

@greatest0fallt1me
greatest0fallt1me merged commit 38696eb into CalloraOrg:main Jul 29, 2026
@greatest0fallt1me

Copy link
Copy Markdown
Contributor

Great work, this looks good. Thanks for the contribution!

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.

Add OpenAPI examples for /api/spike [b#046]

2 participants