This documentation is for WSO2 API Manager 2.5.0. View documentation for the latest release.

All docs This doc

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

ClauseSyntax
By the API's nameAs this is the default option, simply enter the API's name and search.
By the API provider

provider:xxxx. For example, provider:admin

Provider is the user who created the API.

By the API version

version:xxxx. For example, version:1.0.0

A version is given to an API at the time it is created.

By the context

context:xxxx. For example, context:/phoneverify

Context is the URL context of the API that is specified as /<context_name> at the time the API is created.

By the API's status

status:xxxx. For example, status: PUBLISHED

A state is any stage of an API's lifecycle. The default lifecycle stages include created, prototyped, published, deprecated, retired and blocked.

By description

description:xxxx

A description can be given to an API at the time it is created or later. There can be APIs without descriptions as this parameter is optional.

By the subcontext

subcontext:xxxx. For example, subcontext:/checkphonenumber.

A subcontext is the URL pattern of any resource of the API. API resources are created at the time the API is created or later when it is modified. For example, if you create a resource by the name checkphonenumber, then /checkphonenumber becomes one subcontext of the API.

By the content of the API documentation

doc:xxxx

You can create API documentation in-line (using the API Publisher UI itself), by uploading a file or referring to an external URL. This search enables you to give a sentence or word phrase that is inside the in-line documentation and find the API that the documentation is added for.

Unified search

This feature is introduced an improvement to the existing search functionality in the API Store and API Publisher portals, and REST APIs. You can search by entering a term in the search bar to search through all the fields in an API and the contents of its documents.

Follow the steps below to enable this feature.

  1. Open the <API-M_HOME>/repository/conf/registry.xml file. 
  2. Add the following configurations under the indexingConfiguration.indexers.

    Code Block
    <indexer class="org.wso2.carbon.apimgt.impl.indexing.indexer.DocumentIndexer" mediaTypeRegEx="application/vnd.wso2-document\+xml" profiles ="default,api-store,api-publisher"/>

Rate and comment

Rates and comments give useful insights to potential API consumers on the quality and usefulness of an API. You can rate and comment on each API version.

...