feat(AutoComplete): Add API source #125
Conversation
Add api source tag to autocomplete results when API gateway is chosen as the endpoint.
Enable users to set the widget to show the api source in case of using the gateway. Plus adding a new story as an example.
rebuild the package-lock.json
Add the new api source flag to the html d.ts. Build the plain js version.
src/components/widgets/AutocompleteWidget/AutocompleteWidget.tsx
Outdated
Show resolved
Hide resolved
| marginLeft: "10px" | ||
| }} | ||
| > | ||
| {"Source: " + value.source} |
There was a problem hiding this comment.
Why is it necessary to see the full source API address at first glance?
Would it be more user friendly to just show OLS or SKOSMOS or ONTOPORTAL as the badge? The full source address is then shown in the hover.
There was a problem hiding this comment.
What is the correct badge to use is the question. Like "OLS" as the platform name or "TIB" and "ZBmed" as the provider organizations?
There was a problem hiding this comment.
yeah true. But leaving the end-user with the URL of the API doesn't make sense to me. Maybe both (provider and platform) are interesting, but in a presentation that is easy to read. Furthermore, a badge with a long address might lead to overflow of the line. We have use cases that need a small layout (e.g. #98).
There was a problem hiding this comment.
I mean, this is a general point for the Gateway too. At the moment, it expects "ontoportal, ols, skosmos" as the databases. Is this the use-case? I think we should consider that maybe one wants to search based on the provider like zbmed. Do users care more about the software platform or the provider Org?
There was a problem hiding this comment.
Maybe filtering should be allowed for both, provider and platform. Question is, what information do we present on the small space in the autocomplete drop down menu. I'm not sure anymore, if the user needs the software platform information at all. Also the BreadcrumbWidget, especially the short form (mostly a big number) may not be ideal. Maybe we should ask an end-user/create some use cases.
use the backend_type as the api source text, return back the prefix -> shortForm text, fix style issue
|
I liked to get the API URL in the hover menu as a detail information... The idea was to implement the MetadataWidget as hover menu instead of the string as we do it now. There we can provide a lot of detail information such as the provider organisation and the software platform and the API URL. #127 |
|
I did not merge this PR yet, since we didn't find a solution how the new feature should look like. I updated the PR to resolve potential merge conflicts due to a larger update on the main branch. Last idea was to remove the badges and add an "information" (i) icon for the user to hover with detailed information. But we already have this hover function when hovering over a term: The feature currently looks like this: |
use source_name instead of the backend_type. show the source endpoint in the hover box.
|
Last commit changes:
|
@Pooya-Oladazimi You could use |
Added API source tag to autocomplete results when API gateway is chosen as the endpoint.