ForksApi | azure-devops-sdk

Hierarchy

ForksApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ForksApi(basePath?: string): ForksApi

- Defined in api/api.ts:45441
Parameters
- Optional basePath: string
Returns ForksApi

Properties

Protected basePath

basePath: string = "https://dev.azure.com/"

defaultHeaders

defaultHeaders: any

Methods

createForkSyncRequest

createForkSyncRequest(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<GitForkSyncRequest>

- Defined in api/api.ts:45459
Request that another repository's refs be fetched into this one. It syncs two existing forks. To create a fork, please see the <a href="https://docs.microsoft.com/en-us/rest/api/vsts/git/repositories/create?view=azure-devops-rest-5.1"> repositories endpoint</a>

Parameters
- params: object
  - apiVersion: string
  - body: GitForkSyncRequestParameters
  - Optional includeLinks?: boolean
  - organization: string
  - project: string
  - repositoryNameOrId: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<GitForkSyncRequest>

getForkSyncRequest

getForkSyncRequest(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<GitForkSyncRequest>

- Defined in api/api.ts:45530
Get a specific fork sync operation's details.

Parameters
- params: object
  - apiVersion: string
  - forkSyncOperationId: number
  - Optional includeLinks?: boolean
  - organization: string
  - project: string
  - repositoryNameOrId: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<GitForkSyncRequest>

getForkSyncRequests

getForkSyncRequests(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ArrayWrapper<GitForkSyncRequest>>

- Defined in api/api.ts:45599
Retrieve all requested fork sync operations on this repository.

Parameters
- params: object
  - apiVersion: string
  - Optional includeAbandoned?: boolean
  - Optional includeLinks?: boolean
  - organization: string
  - project: string
  - repositoryNameOrId: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<ArrayWrapper<GitForkSyncRequest>>

getForks

getForks(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ArrayWrapper<GitRepositoryRef>>

- Defined in api/api.ts:45667
Retrieve all forks of a repository in the collection.

Parameters
- params: object
  - apiVersion: string
  - collectionId: string
  - Optional includeLinks?: boolean
  - organization: string
  - project: string
  - repositoryNameOrId: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<ArrayWrapper<GitRepositoryRef>>

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional basePath: string

Returns ForksApi

Properties

Protected basePath

defaultHeaders

Methods

createForkSyncRequest

Parameters

params: object

apiVersion: string

body: GitForkSyncRequestParameters

Optional includeLinks?: boolean

organization: string

project: string

repositoryNameOrId: string

Optional extraQueryParams: any

Optional extraFetchParams: any

Returns Promise<GitForkSyncRequest>

getForkSyncRequest

Parameters

params: object

apiVersion: string

forkSyncOperationId: number

Optional includeLinks?: boolean

organization: string

project: string

repositoryNameOrId: string

Optional extraQueryParams: any

Optional extraFetchParams: any

Returns Promise<GitForkSyncRequest>

getForkSyncRequests

Parameters

params: object

apiVersion: string

Optional includeAbandoned?: boolean

Optional includeLinks?: boolean

organization: string

project: string

repositoryNameOrId: string

Optional extraQueryParams: any

Optional extraFetchParams: any

Returns Promise<ArrayWrapper<GitForkSyncRequest>>

getForks

Parameters

params: object

apiVersion: string

collectionId: string

Optional includeLinks?: boolean

organization: string

project: string

repositoryNameOrId: string

Optional extraQueryParams: any

Optional extraFetchParams: any

Returns Promise<ArrayWrapper<GitRepositoryRef>>