Skip to content

Prepare API for public usage#15

Open
ainefairbrother wants to merge 4 commits into
igsr:mainfrom
ainefairbrother:prep-api-for-public
Open

Prepare API for public usage#15
ainefairbrother wants to merge 4 commits into
igsr:mainfrom
ainefairbrother:prep-api-for-public

Conversation

@ainefairbrother
Copy link
Copy Markdown
Collaborator

@ainefairbrother ainefairbrother commented Mar 6, 2026

This PR relates to IGSR-627.

Description

This PR refines the public API documentation.
Linked to igsr/gca_1000genomes_website#82.

Testing

You can view the docs on the test site at https://test.internationalgenome.org/docs/.

@ainefairbrother ainefairbrother marked this pull request as ready for review March 19, 2026 11:34
@ainefairbrother ainefairbrother changed the title fix: update descriptions, examples, remove non public-facing endpoints Prepare API for public usage Mar 19, 2026
ainefairbrother added a commit to ainefairbrother/igsr-be that referenced this pull request Apr 14, 2026
Copy link
Copy Markdown
Collaborator

@likhitha-surapaneni likhitha-surapaneni left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @ainefairbrother . Looks good.

In /beta/file/_search/{filename}.tsv, is filename the output filename?

@ainefairbrother
Copy link
Copy Markdown
Collaborator Author

In /beta/file/_search/{filename}.tsv, is filename the output filename?

Thanks for your feedback @likhitha-surapaneni. As discussed, I cleaned up the download endpoints to pre-fill suggested filename and default json string. These changes are now reflected on the test site at https://test.internationalgenome.org/docs#/.

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.

2 participants