Skip to content
This repository has been archived by the owner on Nov 21, 2024. It is now read-only.

Logo Endpoint #310

Open
NotSpecial opened this issue Oct 14, 2018 · 3 comments
Open

Logo Endpoint #310

NotSpecial opened this issue Oct 14, 2018 · 3 comments
Labels
unresolved Further discussion required.
Milestone

Comments

@NotSpecial
Copy link
Contributor

Several tools we are using allow branding in form of a logo provided by URL.

Examples:

  • ReDoc used by the API itself
  • Portainer (cluster management)
  • Wiki

So far we always need some workarounds to actually host the logo somewhere, e.g. portainer uses a direct URL to a image uploaded to the wiki.

As it's always nice to make a good appearance, the logo should be more reliably accessible,
thus I propose an endpoint '/logo/' for the API, which can serve the different variants of our logo (with/without text etc.)

@cburchert
Copy link
Member

I feel like this is not really a good use of the API, as this content is completely static. If this is really just about Logos, then we should just host a simple HTTP Server like static.amiv.ethz.ch and put stuff there in plain.

@NotSpecial
Copy link
Contributor Author

I see your point, however we do not really have any static content aside from the logo.

The API needs the logo anyway (e.g. for the OAuth login page or the docs), so why not put it on a static endpoint where others can access it as well?

I like the idea that at least the API is self-contained, so using an external server just for a logo seems to me like unnecessary overcomplicating issues.

@NotSpecial
Copy link
Contributor Author

Update: in #325, I now moved the logo we need for OAuth and (soon) the online docs to a static folder served by flask.

However, the discussion in this issue remains:

  • Should we keep it like this and only serve the logo used by the API itself.
  • Do we want a solution that serves different formats of the logo?
  • Do we want to switch to an external host for the logo?

@NotSpecial NotSpecial added the unresolved Further discussion required. label Mar 29, 2019
@NotSpecial NotSpecial added this to the Future milestone Mar 29, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
unresolved Further discussion required.
Projects
None yet
Development

No branches or pull requests

2 participants