Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Change API docs to allow custom URL's #1603

Merged
merged 2 commits into from
Oct 3, 2024
Merged

Change API docs to allow custom URL's #1603

merged 2 commits into from
Oct 3, 2024

Conversation

rien
Copy link
Member

@rien rien commented Oct 2, 2024

This adds an input field to the API documentation which allows someone to change the endpoint URLs shown.

This change is already live and can be viewed on https://dolos.ugent.be/docs/api.html

@rien rien added the documentation Improvements or additions to documentation label Oct 2, 2024
@rien rien requested a review from mikaelGusse October 2, 2024 15:11
@mikaelGusse
Copy link
Collaborator

I really like this idea! Although I am not sure why but the buttons for public API and localhost API don't appear to be working on my side. Tried on Firefox and Chrome on MacOS and on Firefox with Ubuntu.

@rien
Copy link
Member Author

rien commented Oct 3, 2024

Oh, that is strange indeed. It seemed to be working locally, but they are not working on the deployed version for me either.

@rien
Copy link
Member Author

rien commented Oct 3, 2024

I have not done anything and it seems to work now somehow? @mikaelGusse can you try again?

I fear there is something weird going on with the caching.

@rien
Copy link
Member Author

rien commented Oct 3, 2024

Oh, it seems to be broken when you directly load or refresh the page. Looks to be an issue with the eventlistener not being initialized.

@rien
Copy link
Member Author

rien commented Oct 3, 2024

The issue should be fixed now and I have added persistence as well.

@rien rien merged commit f91375c into main Oct 3, 2024
26 checks passed
@rien rien deleted the docs/api-url branch October 3, 2024 09:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants