Skip to main content
Swagger
All documentation pages

Searching Swagger Studio

Use Swagger Studio Search to find APIs and domains by name, content, status, or other attributes. Anonymous users can search among all public definitions. Logged in users can also search among the private definitions they have access to.

My APIs, organization pages and project pages also have a search bar with the search scope limited accordingly.

The search is performed only among the default versions of APIs and domains.

An admin can choose whether Basic or Enhanced search should be enabled. Basic search is enabled by default and Enhanced search is only enabled on request. Text search options vary, depending on what search type is enabled. For the additional requirements for Enhanced search, click here.

Basic and Enhanced search are described below:

Search terms are case-insensitive and are matched against:

  • info.title and info.description in definitions,

  • API and domain names,

  • owner names.

A query containing just one term searches for this term as a substring. For example, book will find book, eBook, bookstore, booking, and so on.

Multiple words, such as petstore server, are treated as an exact substring search – all the words in that exact order. You do not need to enclose the phrase in quotation marks.

Search terms are case-insensitive and are matched against:

  • YAML contents of API definitions and domains,

  • info.title and info.description in definitions,

  • API and domain names,

  • owner names.

Swagger Studio uses full text search. Search queries work as follows:

  • Queries containing multiple terms such as pet store find definitions containing all of these terms anywhere in the definition. This is equivalent to using the boolean AND operator: pet AND store.

  • Each term is matched as a substring. For example, book will find book, eBook, bookstore, booking, and so on.

  • Stop words are ignored. For example, the get a report search string is converted to a report because “get” is ignored as a stop word.

  • The following special characters are ignored and replaced with spaces:

    + - = & | > < ! ( ) { } [ ] ^ " ~ * ? : \ /

    For example, the search string /users/{id} is converted to users id (which in turn is equivalent to users AND id).

  • The exact phrase search (such as “hotel booking”) is not supported.

Boolean operators

You can combine the search terms using boolean operators to expand or narrow down your search. These operators must be uppercase.

AND (default)

Find definitions that contain both terms anywhere.

OR

Find definitions that contain either term.

NOT

Exclude definitions that contain the term after NOT.

Examples:

Filter keywords

Search queries can include the following keywords to filter the search results.

type:api

Find APIs only.

type:domain

Find domains only.

spec:openapi3.0

Find OpenAPI 3.0 definitions.

spec:swagger2.0

Find OpenAPI 2.0 definitions.

spec:asyncapi3.x

Find AsyncAPI 3.x definitions.

spec:asyncapi2.x

Find AsyncAPI 2.x definitions.

owner:name

Find APIs and domains owned by the specified user or organization. Owner names are case-sensitive.

visibility:public

Find public APIs and domains.

visibility:private

Find private definitions owned by you or shared with you. You must be logged in to use this option.

state:published

Find published definitions only.

state:unpublished

Find unpublished definitions only.

standardization:failed

Find APIs with standardization errors or warnings.

standardization:critical

Find APIs with standardization errors.

standardization:warning

Find APIs with standardization warnings.

  • There must be no spaces after the prefixes: owner:fehguy is valid, owner: fehguy is not.

  • Multiple keywords with the same prefix, such as owner:fehguy owner:kesh92, are not supported. The last one will be used.

Examples

Sorting

Search results can be sorted to display them in a specific order. The sort options are:

  • best match (relevance),

  • update date,

  • creation date,

  • API or domain name,

  • API or domain title (info.title),

  • owner name.

Limitation

Search results are limited to 10 000 records.

Was this page helpful?