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

Add API Search to Apigee D8 Kick Start #334

Open
RaymonLPeng opened this issue Mar 6, 2020 · 1 comment
Open

Add API Search to Apigee D8 Kick Start #334

RaymonLPeng opened this issue Mar 6, 2020 · 1 comment
Assignees
Labels
enhancement New feature or request postponed

Comments

@RaymonLPeng
Copy link

Is your feature request related to a problem? Please describe.
Add a site search feature to the Apigee D8 Kick Start bundle and add it to the demo site: http://dev-kickstart-d8.devportal.apigee.io/

Describe the solution you'd like
Add a "Im looking for..." search box, see example on RBC Dev Portal Site:
https://developer.rbc.com/ with basic search results/

The search should cover both API Product/Specs and other pages like Getting Started, FAQ, blog. It would be ok if the blog or forum was excluded as the primary use case is to find a API.

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
Our customers typically will load 100s of APIs if not 1000s of APIs into the Dev Portal. Browsing is not an effective way to find APIs. Also customer expect google to provide great search tool. I would highly suggest to make sure the search works very well and is able to find all APIs on the Dev Portal

@RaymonLPeng RaymonLPeng added the enhancement New feature or request label Mar 6, 2020
@cnovak cnovak added this to the 8.x-1.12 milestone Mar 9, 2020
@arunz6161 arunz6161 modified the milestones: 8.x-1.12, 8.x-1.13 Apr 14, 2020
shadcn added a commit to shadcn/apigee-devportal-kickstart-drupal that referenced this issue May 4, 2020
@shadcn
Copy link
Contributor

shadcn commented May 6, 2020

@RaymonLPeng API product is being converted to Content entities. See apigee/apigee-api-catalog-drupal#71

This means we will have out of the box support for search once this is done.

If you need a solution meanwhile, I created a PR here that replaces the default search with search_api with both Content and API support.

You could apply this PR as a patch.

  1. Install composer-patches:
composer require cweagans/composer-patches
  1. Add the following under extra in your root composer.json file:
    "patches": {
      "apigee/apigee_devportal_kickstart": {
        "Add content and API search": "https://patch-diff.githubusercontent.com/raw/apigee/apigee-devportal-kickstart-drupal/pull/361.patch"
      }
    },
  1. Apply the patch.
composer install
  1. Enable the apigee_kickstart_search module.

Clear your cache and you should be ready to go.

When we release support for API search, you should be able to safely uninstall the module and remove the patch from your composer.json file.

@shadcn shadcn removed this from the 8.x-1.13 milestone May 12, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request postponed
Projects
None yet
Development

No branches or pull requests

4 participants