Skip to content

Add swagger documentation for $match endpoint#824

Open
paynejd wants to merge 1 commit intomasterfrom
fix/match-swagger-docs
Open

Add swagger documentation for $match endpoint#824
paynejd wants to merge 1 commit intomasterfrom
fix/match-swagger-docs

Conversation

@paynejd
Copy link
Copy Markdown
Member

@paynejd paynejd commented Mar 27, 2026

Summary

  • Add @swagger_auto_schema decorator to MetadataToConceptsListView.post() — the $match endpoint previously had no swagger documentation at all
  • Add 8 new $match-specific query parameter definitions to swagger_parameters.py (semantic, bestMatch, numCandidates, kNearest, brief, encoder_model, reranker, offset)
  • Define request body schema with rows, target_repo_url, target_repo, map_config, and filter
  • Document response codes: 200, 400, 403

Companion docs PR: https://github.com/OpenConceptLab/ocl-docs/pull/new/fix/match-api-docs

Test plan

  • Run dev server and verify /swagger/ renders the $match endpoint correctly
  • Confirm all query parameters appear with correct types and defaults
  • Confirm request body schema shows in swagger UI
  • Verify no regressions in other swagger endpoints

🤖 Generated with Claude Code

Add @swagger_auto_schema decorator to MetadataToConceptsListView.post()
with full query parameter definitions, request body schema, and response
codes. Add 8 new $match-specific parameter definitions to swagger_parameters.py.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
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.

1 participant