Clean and Standardize OpenAPI Documentation#555

Merged

bencap merged 33 commits intorelease-2025.5.0from

maintenance/bencap/542/cleanup-open-api-docs

Nov 11, 2025

Commits on Oct 28, 2025

Standardize router tags for clarity and consistency
bencap
committed
fixed: AccessKey object using `created_at` when property was `creation_time`
bencap
committed

Commits on Oct 30, 2025

Enhance API Documentation: Add explicit summaries for access key routes, explicitly define all responses
bencap
committed
fixed: raise appropriate 404 error when access key is not found during deletion attempt
bencap
committed
Enhance API Documentation: Add explicit summary for api version endpoint
bencap
committed
Enhance API documentation: Add summaries and response status descriptions for collection routes
bencap
committed
Enhance API Documentation: Add summaries to controlled keyword routes
bencap
committed
Enhance API Documentation: Improve summary and response descriptions for DOI endpoints
bencap
committed
fixed: permissions were not properly enforced on experiment set fetches
bencap
committed
Enhance API Documentation: Add missing response descriptions and summary for fetch experiment set endpoint
bencap
committed
fixed: Use permission module to check experiments in list router
bencap
committed
fixed: Simplify if/else logic of get experiment sets router
bencap
committed
Enhance API responses and documentation: Add missing response descriptions and summaries for various experiment endpoints
bencap
committed
Enhance API documentation: Add summaries and improve descriptions for HGVS endpoints
bencap
committed
Enhance API documentation: Improve summaries for licenses endpoints
bencap
committed
Enhance API documentation: Add internal server error response description and update log interaction summary
bencap
committed
Enhance API documentation: Add response descriptions and summaries for mapped variant endpoints
bencap
committed
Enhance API documentation: Add internal server error response and improve response descriptions for ORCID endpoints
bencap
committed
Enhance API documentation: Update responses and summary for permissions endpoints
bencap
committed
Enhance API documentation: Improve summaries and response descriptions for publication identifier endpoints
bencap
committed
Enhance API documentation: Update response descriptions and error handling for search endpoint
bencap
committed
Enhance API documentation: Add summaries for service info and metadata endpoints, and improve response descriptions for sequence endpoint
bencap
committed
Enhance API documentation: Add summaries and response descriptions for score set endpoints, and improve error handling for various scenarios
bencap
committed
Enhance API documentation: Add summaries for sequence, metadata, and version endpoints, and improve response descriptions
bencap
committed
Enhance API documentation: Add summaries for various statistics endpoints and improve response descriptions
bencap
committed
Enhance API Documentation: fix response status code for missing search text in target gene identifiers search and add summary text
bencap
committed
Enhance API documentation: Add summaries and response descriptions for target genes endpoints
bencap
committed
Enhance API documentation: Add summaries for taxonomy endpoints
bencap
committed
Enhance API documentation: Add summaries and response descriptions for user endpoints
bencap
committed
Enhance API documentation: Add summaries and response descriptions for variant endpoints
bencap
committed
Clarify HTTP status codes for email and role authorization checks
bencap
committed
Enhance API metadata and tag consistency across routers for improved documentation and clarity
bencap
committed

Commits on Nov 11, 2025

Merge branch 'release-2025.5.0' of https://github.com/VariantEffect/mavedb-api into maintenance/bencap/542/cleanup-open-api-docs
bencap
committed