feat(api): add OpenAPI 3.1 spec with Swagger UI at /docs#91
Merged
Conversation
- OpenAPI 3.1 spec covering all endpoints: dedupe, pipeline, batch, memory (store/recall/forget/expire/supersede/stats), sessions, health - Swagger UI served at /docs via CDN (no dependencies) - Raw spec available at /openapi.yaml - Spec also at repo root for discoverability - Root endpoint updated with docs link and full endpoint list Closes #23 Co-authored-by: Ona <no-reply@ona.com>
Siddhant-K-code
added
documentation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Adds a complete OpenAPI 3.1 specification for the Distill API and serves interactive Swagger UI documentation at
/docs.Why
No machine-readable API description existed. This blocks SDK generation, makes integration harder, and means every consumer has to read source code to understand the API.
Changes
openapi.yaml— full OpenAPI 3.1 spec covering all endpoints:/v1/dedupe,/v1/dedupe/stream)/v1/pipeline)/v1/batch,/v1/batch/{job_id},/v1/batch/{job_id}/results)store,recall,forget,expire,supersede,stats)create,push,context,get,delete)/health,/metrics)GET /docs— Swagger UI served via CDN (zero dependencies)GET /openapi.yaml— raw spec with CORS headers/docslink and complete endpoint list//go:embedUsage
Closes #23