Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface RepositoryApiRepoSearchRequest

Request parameters for repoSearch operation in RepositoryApi.

export
interface

RepositoryApiRepoSearchRequest

Hierarchy

  • RepositoryApiRepoSearchRequest

Index

Properties

_private?: boolean

include private repositories this user has access to (defaults to true)

memberof

RepositoryApiRepoSearch

archived?: boolean

show only archived, non-archived or all repositories (defaults to all)

memberof

RepositoryApiRepoSearch

book?: string

book (project id) that exist in a resource. If the resource contains the the book, its repository will be included in the results. Multiple book's are ORed.

memberof

RepositoryApiRepoSearch

exclusive?: boolean

if `uid` is given, search only for repos that the user owns

memberof

RepositoryApiRepoSearch

includeDesc?: boolean

include search of keyword within repository description (defaults to false)

memberof

RepositoryApiRepoSearch

includeMetadata?: boolean

if false, q value will only be searched for in the repo name, owner, description and title and subject; otherwise search all values of the manifest file. (defaults to false)

memberof

RepositoryApiRepoSearch

isPrivate?: boolean

show only pubic, private or all repositories (defaults to all)

memberof

RepositoryApiRepoSearch

lang?: string

If the repo is a resource of the given language(s), the repo will be in the results. Multiple lang's are ORed.

memberof

RepositoryApiRepoSearch

limit?: number

page size of results

memberof

RepositoryApiRepoSearch

mode?: string

type of repository to search for. Supported values are "fork", "source", "mirror" and "collaborative"

memberof

RepositoryApiRepoSearch

order?: string

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

memberof

RepositoryApiRepoSearch

owner?: string

owner of the repo. Multiple owner's are ORed.

memberof

RepositoryApiRepoSearch

page?: number

page number of results to return (1-based)

memberof

RepositoryApiRepoSearch

priorityOwnerId?: number

repo owner to prioritize in the results

memberof

RepositoryApiRepoSearch

q?: string

keyword

memberof

RepositoryApiRepoSearch

repo?: string

name of the repo. Multiple repo's are ORed.

memberof

RepositoryApiRepoSearch

sort?: string

sort repos by attribute. Supported values are "alpha", "created", "updated", "size", and "id". Default is "alpha"

memberof

RepositoryApiRepoSearch

starredBy?: number

search only for repos that the user with the given id has starred

memberof

RepositoryApiRepoSearch

subject?: string

resource subject. Multiple subject's are ORed.

memberof

RepositoryApiRepoSearch

teamId?: number

search only for repos that belong to the given team id

memberof

RepositoryApiRepoSearch

template?: boolean

include template repositories this user has access to (defaults to true)

memberof

RepositoryApiRepoSearch

topic?: boolean

Limit search to repositories with keyword as topic

memberof

RepositoryApiRepoSearch

uid?: number

search only for repos that the user with the given id owns or contributes to

memberof

RepositoryApiRepoSearch

Generated using TypeDoc