Skip to content

Update search docs, add swagger UI#258

Open
kkaris wants to merge 25 commits into
gyorilab:masterfrom
kkaris:update-search-docs
Open

Update search docs, add swagger UI#258
kkaris wants to merge 25 commits into
gyorilab:masterfrom
kkaris:update-search-docs

Conversation

@kkaris

@kkaris kkaris commented Feb 27, 2026

Copy link
Copy Markdown
Contributor

This PR adds an openapi spec for some of the endpoints in api.py and adds a swagger ui page for those endpoints.

Specific updates:

  • Root README.md: fix some warnings.
  • Documentation:
    • New sphinx dependencies to support openapi usage and collapsing long sections.
    • rest api documentation
      • indra_db_service/README.md was renamed to rest_api.rst and moved to doc/rest_api_doc
      • Updated language and examples to reflect current state of app
      • Add endpoint documentation based on openapi.yaml spec for each documented endpoint
      • Add documentation for /curation/list endpoints
    • Service API README
      • indra_db_service/search_introduction.md was renamed to search_introduction.rst and moved to doc/web_ui_doc/
      • Updated screenshot of results
      • Updated language to reflect current state of app
    • Add openapi.yaml to indra_db_service/static/
  • indra_db_service/api.py
    • Add endpoint for serving openapi.yaml at /openapi.yaml
    • Add endpoint for serving Swagger UI at /api-docs

See screenshot of Swagger UI below

image

@kkaris kkaris force-pushed the update-search-docs branch from cec1ba8 to 028e3b0 Compare March 2, 2026 17:28
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