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

feat(website): show API URLs on API documentation page #3359

Merged
merged 3 commits into from
Dec 29, 2024
Merged

Conversation

chaoran-chen
Copy link
Member

resolves #3358

preview URL: https://api-urls.loculus.org/api-documentation

Summary

This displays the API URLs directly on the API documentation page.

PR Checklist

  • [ ] All necessary documentation has been adapted.
  • [ ] The implemented feature is covered by an appropriate test.

@chaoran-chen chaoran-chen added the preview Triggers a deployment to argocd label Dec 4, 2024
@chaoran-chen chaoran-chen marked this pull request as draft December 4, 2024 07:59
@fhennig
Copy link
Contributor

fhennig commented Dec 4, 2024

As Anya noted, the KC URL is the internal one (That's probably why you made the PR a draft again 😁 )

@chaoran-chen
Copy link
Member Author

chaoran-chen commented Dec 4, 2024

@fhennig Yes.. Any thoughts on how I can get the Keycloak root API? We have a getAuthUrl function but how do I get the root link? We cannot simply trim at the domain because a deployment could also put Keycloak at, for example, /auth, I think.

Now, I'm also noticing that host might actually not be the right term because a link with ".../west-nile" is not really a host. What do you think?

Copy link
Contributor

@fhennig fhennig left a comment

Choose a reason for hiding this comment

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

looks correct!

But the KC server seems to have issues? If I just try to log in, it doesn't work. But I think it's not related to your changes

@chaoran-chen chaoran-chen removed the preview Triggers a deployment to argocd label Dec 5, 2024
@chaoran-chen chaoran-chen added the preview Triggers a deployment to argocd label Dec 29, 2024
@chaoran-chen chaoran-chen merged commit 23a1c8c into main Dec 29, 2024
21 checks passed
@chaoran-chen chaoran-chen deleted the api-urls branch December 29, 2024 12:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
preview Triggers a deployment to argocd
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Make API URLs easier to find
2 participants