Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Searching functionality in developer portal

See original GitHub issue


I am trying out the CMS capabilities of Azure APIM Developer Portal. I understand that for page types Products and APIs, there is a search functionality to look for relevant APIs or Products added as part of the APIM. Is there any searching functionality to look for content added as part of the CMS?

e.g. I am trying to design a listing page for developer guides and I want to add a keyword-based searching option to find relevant guides. Is it possible to add such an option in a listing page apart from Product or API?

Screen Shot 2020-11-02 at 21 30 52

Issue Analytics

  • State:open
  • Created 3 years ago
  • Comments:6 (4 by maintainers)

github_iconTop GitHub Comments

mikebudzynskicommented, Feb 17, 2021

From @AnRei123 in #881:

Yes, the missing search functionality for static content is also an issue for and urgently needed as our amount of static content is increasing continuously.

  1. The search should allow to filter for all page titles that contain a dedicated string. Matches in the title shall be ranked higher than matches in the description. This must be reflected in the list with the search results.
  2. The search should allow to filter for all page contents that a dedicated string or a combination of several strings. (searching for one string might not always sufficient. The search result should list the page titles and offer an extension to see the first three sentences of a page. Navigating to the search target should highlight the the strings on the page to easier navigate on the target page. If no string is entered in the search field, the complete list with all static pages should be listed in a scrollable manner to allow getting an overview and an impression on the available and amounts of contents. The titles of the pages should be listed in an alphabetically order.
  3. A configurable web widget is required for add a search field in the header that also contains the main navigation.
  4. The search shall also allow to search not only in the static content, but also in the descriptions of API products, APIs and operations according to the access rights of the DevPortal user. As we have a mixed approach to document our APIs, it is very important that all contents of the DevPortal are considered for the full-text search - the static page content and the dynamic API content including names of operations and all kinds of descriptions. The search widget shall be configurable accordingly. There should be also offered different sizes and appearances for the different placements on the WebPortal page. The search widget should be configurable, if the search should search for dynamic API contents only or static content or a combination of it. The size (length, width) of the search field and the display of the zoom icon should be configurable as well.
mikebudzynskicommented, Apr 11, 2022

The best way to stay updated is to subscribe to this issue for notifications. We also post detailed release notes in the Releases section of this repository as well as in the main API Management releases repository.

Read more comments on GitHub >

github_iconTop Results From Across the Web

Using Search API to enhance search functionality on the ...
Go to Search API's administration page at Administration > Configuration > Search and metadata > Search API (or ...
Read more >
Search API: Understanding and Using - Documentation
The Search API is an XQuery library that combines searching, search parsing, search grammar, faceting, snippeting, search term completion, and other search ......
Read more >
Searching in API Portal - Software AG Documentation
The search feature in API Portal is a type-ahead search; a simple and easy to use search facility where you can type the...
Read more >
Searching functionality tutorial | Global Developer Portal
Searching functionality tutorial. Search functionality Picture 1. Welcome again to this tutorial. As mentioned before, Unified UI for Signature enables you ...
Read more >
What to look for in a search API | Algolia
Search APIs are software components that allow developers to seamlessly introduce search capabilities to websites and applications. They provide ...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Post

No results found

github_iconTop Related Hashnode Post

No results found