Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface CatalogApiCatalogSearchRequest

Request parameters for catalogSearch operation in CatalogApi.

export
interface

CatalogApiCatalogSearchRequest

Hierarchy

  • CatalogApiCatalogSearchRequest

Index

Properties

book?: string

search only for entries with the given book(s) (project ids). To match multiple, give the parameter multiple times or give a list comma delimited. Will perform an exact match (case insensitive)

memberof

CatalogApiCatalogSearch

checkingLevel?: string

search only for entries with the given checking level(s). Can be 1, 2 or 3

memberof

CatalogApiCatalogSearch

includeHistory?: boolean

if true, all releases, not just the latest, are included. Default is false

memberof

CatalogApiCatalogSearch

includeMetadata?: boolean

if false, only subject and title are searched with query terms, if true all metadata values are searched. Default is true

memberof

CatalogApiCatalogSearch

lang?: string

search only for entries with the given language(s). To match multiple, give the parameter multiple times or give a list comma delimited. Will perform an exact match (case insensitive) unlesss partialMatch=true

memberof

CatalogApiCatalogSearch

limit?: number

page size of results, defaults to no limit

memberof

CatalogApiCatalogSearch

order?: string

sort order, either "asc" (ascending) or "desc" (descending). Default is "asc", ignored if "sort" is not specified.

memberof

CatalogApiCatalogSearch

owner?: string

search only for entries with the given owner name(s). Will perform an exact match (case insensitive) unlesss partialMatch=true

memberof

CatalogApiCatalogSearch

page?: number

page number of results to return (1-based)

memberof

CatalogApiCatalogSearch

partialMatch?: boolean

if true, subject, owner and repo search fields will use partial match (LIKE) when querying the catalog. Default is false

memberof

CatalogApiCatalogSearch

q?: string

keyword(s). Can use multiple `q=<keyword>`s or a comma-delimited string for more than one keyword. Is case insensitive

memberof

CatalogApiCatalogSearch

repo?: string

search only for entries with the given repo name(s). To match multiple, give the parameter multiple times or give a list comma delimited. Will perform an exact match (case insensitive) unlesss partialMatch=true

memberof

CatalogApiCatalogSearch

showIngredients?: boolean

if true, a list of the projects in the resource and their file paths will be listed for each entry. Default is false

memberof

CatalogApiCatalogSearch

sort?: string

sort repos alphanumerically by attribute. Supported values are &quot;subject&quot;, &quot;title&quot;, &quot;reponame&quot;, &quot;tag&quot;, &quot;released&quot;, &quot;lang&quot;, &quot;releases&quot;, &quot;stars&quot;, &quot;forks&quot;. Default is by &quot;language&quot;, &quot;subject&quot; and then &quot;tag&quot;

memberof

CatalogApiCatalogSearch

stage?: string

specifies which release stage to be return of these stages: &quot;prod&quot; - return only the production releases (default); &quot;preprod&quot; - return the pre-production release if it exists instead of the production release; &quot;draft&quot; - return the draft release if it exists instead of pre-production or production release; &quot;latest&quot; -return the default branch (e.g. master) if it is a valid RC instead of the above

memberof

CatalogApiCatalogSearch

subject?: string

search only for entries with the given subject(s). To match multiple, give the parameter multiple times or give a list comma delimited. Will perform an exact match (case insensitive) unlesss partialMatch=true

memberof

CatalogApiCatalogSearch

tag?: string

search only for entries with the given release tag(s). To match multiple, give the parameter multiple times or give a list comma delimited. Will perform an exact match (case insensitive)

memberof

CatalogApiCatalogSearch

Generated using TypeDoc