6.0.0 • Published 5 years ago

@datafire/appveyor v6.0.0

Weekly downloads
1
License
MIT
Repository
github
Last release
5 years ago

@datafire/appveyor

Client library for AppVeyor REST API

Installation and Usage

npm install --save @datafire/appveyor
let appveyor = require('@datafire/appveyor').create({
  apiToken: ""
});

.then(data => {
  console.log(data);
});

Description

AppVeyor is a hosted continuous integration service which runs on Microsoft Windows. The AppVeyor REST API provides a RESTful way to interact with the AppVeyor service. This includes managing projects, builds, deployments, and the teams that build them.

Additional help and discussion of the AppVeyor REST API is available at http://help.appveyor.com/discussions

This Swagger definition is an unofficial description of the AppVeyor REST API maintained at https://github.com/kevinoid/appveyor-swagger Please report any issues or suggestions for this Swagger definition at https://github.com/kevinoid/appveyor-swagger/issues/new

API Conventions

Fields which are missing from update operations (PUT requests) are typically reset to their default values. So although most fields are not technically required, they should usually be specified in practice.

Actions

encryptValue

Encrypt a value for use in StoredValue.

appveyor.encryptValue({
  "body": {}
}, context)

Input

Output

  • output string

getBuildArtifacts

Get build artifacts

appveyor.getBuildArtifacts({
  "jobId": ""
}, context)

Input

  • input object
    • jobId required string: Build ID (jobId property of BuildJob)

Output

getBuildArtifact

Download build artifact

appveyor.getBuildArtifact({
  "jobId": "",
  "artifactFileName": ""
}, context)

Input

  • input object
    • jobId required string: Build ID (jobId property of BuildJob)
    • artifactFileName required string: File name (or path) of a build artifact file.

Output

  • output file

getBuildLog

Download build log

appveyor.getBuildLog({
  "jobId": ""
}, context)

Input

  • input object
    • jobId required string: Build ID (jobId property of BuildJob)

Output

  • output file

startBuild

Start build of branch most recent commit

appveyor.startBuild({
  "body": {
    "accountName": "",
    "projectSlug": ""
  }
}, context)

Input

Output

reRunBuild

If reRunIncomplete is true and all jobs in the referenced build completed successfully, a 500 Internal Server Error is returned with the message "No failed or cancelled jobs in build with ID {buildId}".

appveyor.reRunBuild({
  "body": {
    "buildId": 0
  }
}, context)

Input

Output

cancelBuild

Cancel build

appveyor.cancelBuild({
  "accountName": "",
  "projectSlug": "",
  "buildVersion": ""
}, context)

Input

  • input object
    • accountName required string: AppVeyor account name (accountName property of UserAccount)
    • projectSlug required string: Project Slug
    • buildVersion required string: Build Version (version property of Build)

Output

Output schema unknown

getCollaborators

Get collaborators

appveyor.getCollaborators(null, context)

Input

This action has no parameters

Output

addCollaborator

Add collaborator

appveyor.addCollaborator({
  "body": {
    "email": "",
    "roleId": 0
  }
}, context)

Input

Output

Output schema unknown

updateCollaborator

Update collaborator

appveyor.updateCollaborator({
  "body": {
    "userId": 0,
    "roleId": 0
  }
}, context)

Input

Output

Output schema unknown

deleteCollaborator

Delete collaborator

appveyor.deleteCollaborator({
  "userId": 0
}, context)

Input

  • input object
    • userId required integer: User ID

Output

Output schema unknown

getCollaborator

Get collaborator

appveyor.getCollaborator({
  "userId": 0
}, context)

Input

  • input object
    • userId required integer: User ID

Output

startDeployment

Start deployment

appveyor.startDeployment({
  "body": {
    "environmentName": "",
    "accountName": "",
    "projectSlug": "",
    "buildVersion": ""
  }
}, context)

Input

Output

cancelDeployment

Cancel deployment

appveyor.cancelDeployment({
  "body": {
    "deploymentId": 0
  }
}, context)

Input

Output

Output schema unknown

getDeployment

Get deployment

appveyor.getDeployment({
  "deploymentId": 0
}, context)

Input

  • input object
    • deploymentId required integer: Deployment ID (deploymentId property of Deployment)

Output

getEnvironments

Get environments

appveyor.getEnvironments(null, context)

Input

This action has no parameters

Output

addEnvironment

Add environment

appveyor.addEnvironment({
  "body": {
    "name": "",
    "provider": "",
    "settings": {}
  }
}, context)

Input

Output

updateEnvironment

Update environment

appveyor.updateEnvironment({
  "body": null
}, context)

Input

Output

deleteEnvironment

Delete environment

appveyor.deleteEnvironment({
  "deploymentEnvironmentId": 0
}, context)

Input

  • input object
    • deploymentEnvironmentId required integer: Deployment Environment ID (deploymentEnvironmentId property of DeploymentEnvironment)

Output

Output schema unknown

getEnvironmentDeployments

Get environment deployments

appveyor.getEnvironmentDeployments({
  "deploymentEnvironmentId": 0
}, context)

Input

  • input object
    • deploymentEnvironmentId required integer: Deployment Environment ID (deploymentEnvironmentId property of DeploymentEnvironment)

Output

getEnvironmentSettings

Get environment settings

appveyor.getEnvironmentSettings({
  "deploymentEnvironmentId": 0
}, context)

Input

  • input object
    • deploymentEnvironmentId required integer: Deployment Environment ID (deploymentEnvironmentId property of DeploymentEnvironment)

Output

getProjects

Get projects

appveyor.getProjects(null, context)

Input

This action has no parameters

Output

addProject

Add project

appveyor.addProject({
  "body": {
    "repositoryProvider": "",
    "repositoryName": ""
  }
}, context)

Input

Output

updateProject

Update project

appveyor.updateProject({
  "body": {
    "versionFormat": "",
    "configuration": {}
  }
}, context)

Input

Output

Output schema unknown

getPublicProjectStatusBadge

Get status badge image for a project with a public repository

appveyor.getPublicProjectStatusBadge({
  "badgeRepoProvider": "",
  "repoAccountName": "",
  "repoSlug": ""
}, context)

Input

  • input object
    • branch string: Repository Branch
    • svg boolean: Return an SVG image instead of PNG? Exclusive with retina.
    • retina boolean: Return a larger image suitable for retina displays? Exclusive with svg.
    • passingText string: Text to show in badge when build is passing.
    • failingText string: Text to show in badge when build is failing.
    • pendingText string: Text to show in badge when build is pending.
    • badgeRepoProvider required string (values: bitBucket, gitHub): Repository provider supported for badges
    • repoAccountName required string: Account name with repository provider
    • repoSlug required string: Slug (URL component) of repository.

Output

  • output file

getProjectStatusBadge

Get project status badge image

appveyor.getProjectStatusBadge({
  "statusBadgeId": ""
}, context)

Input

  • input object
    • svg boolean: Return an SVG image instead of PNG? Exclusive with retina.
    • retina boolean: Return a larger image suitable for retina displays? Exclusive with svg.
    • passingText string: Text to show in badge when build is passing.
    • failingText string: Text to show in badge when build is failing.
    • pendingText string: Text to show in badge when build is pending.
    • statusBadgeId required string: ID of the status badge (statusBadgeId from ProjectWithConfiguration).

Output

  • output file

getProjectBranchStatusBadge

Get project branch status badge image

appveyor.getProjectBranchStatusBadge({
  "statusBadgeId": "",
  "buildBranch": ""
}, context)

Input

  • input object
    • svg boolean: Return an SVG image instead of PNG? Exclusive with retina.
    • retina boolean: Return a larger image suitable for retina displays? Exclusive with svg.
    • passingText string: Text to show in badge when build is passing.
    • failingText string: Text to show in badge when build is failing.
    • pendingText string: Text to show in badge when build is pending.
    • statusBadgeId required string: ID of the status badge (statusBadgeId from ProjectWithConfiguration).
    • buildBranch required string: Build Branch

Output

  • output file

deleteProject

Delete project

appveyor.deleteProject({
  "accountName": "",
  "projectSlug": ""
}, context)

Input

  • input object
    • accountName required string: AppVeyor account name (accountName property of UserAccount)
    • projectSlug required string: Project Slug

Output

Output schema unknown

getProjectLastBuild

Get project last build

appveyor.getProjectLastBuild({
  "accountName": "",
  "projectSlug": ""
}, context)

Input

  • input object
    • accountName required string: AppVeyor account name (accountName property of UserAccount)
    • projectSlug required string: Project Slug

Output

getProjectArtifact

The job parameter is mandatory if the build contains multiple jobs.

appveyor.getProjectArtifact({
  "accountName": "",
  "projectSlug": "",
  "artifactFileName": ""
}, context)

Input

  • input object
    • accountName required string: AppVeyor account name (accountName property of UserAccount)
    • projectSlug required string: Project Slug
    • artifactFileName required string: File name (or path) of a build artifact file.
    • branch string: Repository Branch
    • tag string: A git (or other VCS) tag
    • job string: Name of the build job.
    • all boolean: Include not only successful, but also jobs with failed, and
    • pr boolean: Include PR builds in the search results?

Output

  • output file

getProjectLastBuildBranch

Get project last branch build

appveyor.getProjectLastBuildBranch({
  "accountName": "",
  "projectSlug": "",
  "buildBranch": ""
}, context)

Input

  • input object
    • accountName required string: AppVeyor account name (accountName property of UserAccount)
    • projectSlug required string: Project Slug
    • buildBranch required string: Build Branch

Output

getProjectBuildByVersion

Get project build by version

appveyor.getProjectBuildByVersion({
  "accountName": "",
  "projectSlug": "",
  "buildVersion": ""
}, context)

Input

  • input object
    • accountName required string: AppVeyor account name (accountName property of UserAccount)
    • projectSlug required string: Project Slug
    • buildVersion required string: Build Version (version property of Build)

Output

deleteProjectBuildCache

Delete project build cache

appveyor.deleteProjectBuildCache({
  "accountName": "",
  "projectSlug": ""
}, context)

Input

  • input object
    • accountName required string: AppVeyor account name (accountName property of UserAccount)
    • projectSlug required string: Project Slug

Output

Output schema unknown

getProjectDeployments

Get project deployments

appveyor.getProjectDeployments({
  "accountName": "",
  "projectSlug": "",
  "recordsNumber": 0
}, context)

Input

  • input object
    • accountName required string: AppVeyor account name (accountName property of UserAccount)
    • projectSlug required string: Project Slug
    • recordsNumber required integer: Number of results to include in the response. getProjectDeployments is documented to have a maximum of 20. It currently returns 500 Internal Server Error for recordsNumber <= 5. In the past it has returned 500 Internal Server Error for many different values which did not match the value used by the ci.appveyor.com web interface at the time. As of 2018-09-08, the value used by the web interface is 10.

Output

getProjectHistory

Get project history

appveyor.getProjectHistory({
  "recordsNumber": 0,
  "accountName": "",
  "projectSlug": ""
}, context)

Input

  • input object
    • recordsNumber required integer: Number of results to include in the response. getProjectDeployments is documented to have a maximum of 20. It currently returns 500 Internal Server Error for recordsNumber <= 5. In the past it has returned 500 Internal Server Error for many different values which did not match the value used by the ci.appveyor.com web interface at the time. As of 2018-09-08, the value used by the web interface is 10.
    • startBuildId integer: Maximum buildId to include in the results (exclusive).
    • branch string: Repository Branch
    • accountName required string: AppVeyor account name (accountName property of UserAccount)
    • projectSlug required string: Project Slug

Output

getProjectSettings

Get project settings

appveyor.getProjectSettings({
  "accountName": "",
  "projectSlug": ""
}, context)

Input

  • input object
    • accountName required string: AppVeyor account name (accountName property of UserAccount)
    • projectSlug required string: Project Slug

Output

updateProjectBuildNumber

Update project build number

appveyor.updateProjectBuildNumber({
  "body": {
    "nextBuildNumber": 0
  },
  "accountName": "",
  "projectSlug": ""
}, context)

Input

  • input object
    • body required ProjectBuildNumberUpdate
    • accountName required string: AppVeyor account name (accountName property of UserAccount)
    • projectSlug required string: Project Slug

Output

Output schema unknown

getProjectEnvironmentVariables

Get project environment variables

appveyor.getProjectEnvironmentVariables({
  "accountName": "",
  "projectSlug": ""
}, context)

Input

  • input object
    • accountName required string: AppVeyor account name (accountName property of UserAccount)
    • projectSlug required string: Project Slug

Output

updateProjectEnvironmentVariables

Update project environment variables

appveyor.updateProjectEnvironmentVariables({
  "body": [],
  "accountName": "",
  "projectSlug": ""
}, context)

Input

  • input object
    • body required array
    • accountName required string: AppVeyor account name (accountName property of UserAccount)
    • projectSlug required string: Project Slug

Output

Output schema unknown

getProjectSettingsYaml

Get project settings in YAML

appveyor.getProjectSettingsYaml({
  "accountName": "",
  "projectSlug": ""
}, context)

Input

  • input object
    • accountName required string: AppVeyor account name (accountName property of UserAccount)
    • projectSlug required string: Project Slug

Output

  • output string

updateProjectSettingsYaml

Update project settings in YAML

appveyor.updateProjectSettingsYaml({
  "body": "",
  "accountName": "",
  "projectSlug": ""
}, context)

Input

  • input object
    • body required string
    • accountName required string: AppVeyor account name (accountName property of UserAccount)
    • projectSlug required string: Project Slug

Output

Output schema unknown

getRoles

Get roles

appveyor.getRoles(null, context)

Input

This action has no parameters

Output

  • output array

addRole

Add role

appveyor.addRole({
  "body": {
    "name": ""
  }
}, context)

Input

Output

updateRole

Update role

appveyor.updateRole({
  "body": null
}, context)

Input

Output

deleteRole

Delete role

appveyor.deleteRole({
  "roleId": 0
}, context)

Input

  • input object
    • roleId required integer: Role ID

Output

Output schema unknown

getRole

Get role

appveyor.getRole({
  "roleId": 0
}, context)

Input

  • input object
    • roleId required integer: Role ID

Output

getUsers

Get users

appveyor.getUsers(null, context)

Input

This action has no parameters

Output

addUser

Add user

appveyor.addUser({
  "body": {
    "fullName": "",
    "email": "",
    "roleId": 0
  }
}, context)

Input

Output

Output schema unknown

updateUser

Update user

appveyor.updateUser({
  "body": null
}, context)

Input

Output

Output schema unknown

deleteUser

Delete user

appveyor.deleteUser({
  "userId": 0
}, context)

Input

  • input object
    • userId required integer: User ID

Output

Output schema unknown

getUser

Get user

appveyor.getUser({
  "userId": 0
}, context)

Input

  • input object
    • userId required integer: User ID

Output

Definitions

AccessRightName

  • AccessRightName string (values: Delete, Deploy, RunBuild, Update, View)

AceAccessRight

AceAccessRightDefinition

  • AceAccessRightDefinition object

Artifact

  • Artifact object
    • name string
    • path required string: Path glob of artifact files.
    • type ArtifactType

ArtifactModel

  • ArtifactModel object
    • created string
    • fileName string
    • name string
    • size integer
    • type ArtifactType
    • url string: This property has not been observed in JSON responses, but is

ArtifactType

  • ArtifactType string (values: Auto, AzureCloudService, AzureCloudServiceConfig, ElasticBeanstalkPackage, File, NuGetPackage, OctopusPackage, SsdtPackage, WebDeployPackage, Zip): Possible values from Push-AppveyorArtifact cmdlet -Type parameter.

Build

  • Build
    • branch string
    • buildId integer
    • message string
    • version string
    • created string
    • updated string
    • authorName string
    • authorUsername string
    • buildNumber integer
    • commitId string
    • committed string
    • committerName string
    • committerUsername string
    • finished string
    • isTag boolean
    • jobs array: Always empty in getProjectHistory and startDeployment responses.
    • messageExtended string
    • messages array
    • projectId integer
    • pullRequestId integer
    • pullRequestName string
    • started string
    • status Status

BuildCloudName

  • BuildCloudName string (values: azure-westus, gce, pro-ubuntu, pro-ubuntu18, pro-vs2013, pro-win2016, pro-vs2017, ubuntu)

BuildJob

  • BuildJob
    • created string
    • updated string
    • finished string
    • jobId string
    • name string
    • started string
    • status Status
    • allowFailure boolean
    • artifactsCount integer
    • compilationErrorsCount integer
    • compilationMessagesCount integer
    • compilationWarningsCount integer
    • failedTestsCount integer
    • messagesCount integer
    • osType OSType
    • passedTestsCount integer
    • testsCount integer

BuildLookupModel

  • BuildLookupModel object
    • branch string
    • buildId integer
    • message string
    • version string

BuildMessage

BuildMessageCategory

  • BuildMessageCategory string (values: information, warning)

BuildMode

  • BuildMode string (values: msbuild, none, script)

BuildNotificationFrequency

  • BuildNotificationFrequency string (values: all, myCommits, none)

BuildStartRequest

  • BuildStartRequest object
    • accountName required string
    • branch string
    • commitId string
    • environmentVariables object
    • projectSlug required string
    • pullRequestId integer: Can not be used with branch or commitId

BuildWorkerImage

BuildWorkerImageName

  • BuildWorkerImageName string (values: Previous Ubuntu, Previous Ubuntu1604, Previous Ubuntu1804, Previous Visual Studio 2013, Previous Visual Studio 2015, Previous Visual Studio 2017, Ubuntu, Ubuntu1604, Ubuntu1804, Visual Studio 2013, Visual Studio 2015, Visual Studio 2015 2, Visual Studio 2017, Visual Studio 2017 Preview, Visual Studio 2019 Preview, WMF 5, Windows Server 2019): Defines the available build worker image templates used to provision a virtual machine for a build. Images are updated regularly. "Previous" selects the previous version of an image, for use as a temporary workaround for regressions.

CollaboratorAddition

  • CollaboratorAddition object: Technically roleId has default value 0 and is not required, but
    • email required string
    • roleId required integer

CollaboratorUpdate

  • CollaboratorUpdate object: Technically userId and roleId have default value 0 and are not
    • roleId required integer
    • userId required integer

DeployMode

  • DeployMode string (values: providers, none, script)

Deployment

DeploymentCancellation

  • DeploymentCancellation object
    • deploymentId required integer

DeploymentEnvironment

  • DeploymentEnvironment
    • deploymentEnvironmentId integer
    • name string
    • provider DeploymentProviderType
    • created string
    • updated string
    • accountId integer
    • projectsMode integer (values: 0, 1, 2): 0 is "Any project can be deployed to the environment"
    • securityDescriptor SecurityDescriptor
    • tags string: Comma-separated list of environment tags for dynamic grouping.

DeploymentEnvironmentAddition

DeploymentEnvironmentDeploymentsResults

DeploymentEnvironmentLookupModel

  • DeploymentEnvironmentLookupModel object

DeploymentEnvironmentProject

  • DeploymentEnvironmentProject object
    • isSelected required boolean
    • name required string
    • projectId required integer

DeploymentEnvironmentSettings

DeploymentEnvironmentSettingsResults

DeploymentEnvironmentWithSettings

  • DeploymentEnvironmentWithSettings
    • deploymentEnvironmentId integer
    • name string
    • provider DeploymentProviderType
    • created string
    • updated string
    • accountId integer
    • projectsMode integer (values: 0, 1, 2): 0 is "Any project can be deployed to the environment"
    • securityDescriptor SecurityDescriptor
    • tags string: Comma-separated list of environment tags for dynamic grouping.
    • environmentAccessKey string
    • projects array: Projects available for selection in UI.
    • selectedProjects array: Project IDs of selected projects
      • items integer
    • settings DeploymentEnvironmentSettings

DeploymentJob

  • DeploymentJob
    • created string
    • updated string
    • finished string
    • jobId string
    • name string
    • started string
    • status Status
    • messagesCount integer

DeploymentLookupModel

  • DeploymentLookupModel object

DeploymentNotificationFrequency

  • DeploymentNotificationFrequency string (values: all, none)

DeploymentProvider

DeploymentProviderType

  • DeploymentProviderType string (values: Agent, AzureBlob, AzureCS, AzureWebJob, BinTray, FTP, GitHub, NuGet, S3, SqlDatabase, WebDeploy, Webhook)

DeploymentStartRequest

  • DeploymentStartRequest object
    • accountName required string
    • buildJobId string: Optional job id with artifacts if build contains multiple jobs.
    • buildVersion required string: Build to deploy
    • environmentName required string
    • environmentVariables object
    • projectSlug required string

EncryptRequest

  • EncryptRequest object
    • plainValue string

EnvironmentDeploymentModel

Error

  • Error object: Schema of object returned in 4XX and 5XX responses.
    • message required string
    • modelState object: When present, this property is a map of property names in the format

GroupName

  • GroupName string (values: Account, BuildEnvironment, Deny, Environments, Projects, Roles, User, Users)

GroupPermissions

HostEntry

  • HostEntry object
    • host required string
    • ip required string

HttpMethodRestricted

  • HttpMethodRestricted string (values: GET, POST)

Job

  • Job
    • created string
    • updated string
    • finished string
    • jobId string
    • name string
    • started string
    • status Status

MSBuildVerbosity

  • MSBuildVerbosity string (values: quiet, minimal, normal, detailed)

NotificationProviderSettings

NotificationProviderType

  • NotificationProviderType string (values: Campfire, Email, GitHubPullRequest, HipChat, Slack, Webhook, VSOTeamRoom)

NotificationSettings

  • NotificationSettings object: This type is the union of the settings types for each of the various
    • $type NotificationSettingsType
    • account string
    • addCustomRequestBody boolean
    • authToken StoredValue
    • bodyTemplate string
    • channel string
    • customRequestBody string
    • customRequestBodyContentType string
    • from string
    • headers array
    • headersValue string
    • incomingWebhookUrl string
    • method HttpMethodRestricted
    • onBuildFailure boolean
    • onBuildStatusChanged boolean
    • onBuildSuccess boolean
    • password StoredValue
    • recipients array
    • recipientsValue string
    • room string
    • serverUrl string
    • subjectTemplate string
    • template string
    • url string
    • username string
    • vsoAccount string

NotificationSettingsType

  • NotificationSettingsType string (values: Appveyor.Models.CampfireNotificationSettings, Appveyor.Models, Appveyor.Models.EmailNotificationSettings, Appveyor.Models, Appveyor.Models.GitHubPullRequestNotificationSettings, Appveyor.Models, Appveyor.Models.HipChatNotificationSettings, Appveyor.Models, Appveyor.Models.SlackNotificationSettings, Appveyor.Models, Appveyor.Models.WebhookNotificationSettings, Appveyor.Models, Appveyor.Models.VSOTeamRoomNotificationSettings, Appveyor.Models)

NuGetFeed

  • NuGetFeed
    • created string
    • updated string
    • accountId integer
    • id string
    • isPrivateProject boolean
    • name string
    • nuGetFeedId integer
    • projectId integer
    • publishingEnabled boolean

OSServiceName

  • OSServiceName string (values: iis, mongodb, msmq, mssql2008r2sp2, mssql2008r2sp2rs, mssql2012sp1, mssql2012sp1rs, mssql2014, mssql2014rs, mssql2016, mysql, postgresql)

OSType

  • OSType string (values: Ubuntu, Windows)

PermissionName

  • PermissionName string (values: ManageApplicationAuthorizations, UpdateAccountDetails, UpdateBillingDetails, ConfigureBuildEnvironment, DenyAllProjectsEnvironments, DeployToEnvironment, ManageEnvironments, UpdateEnvironmentSettings, ManageProjects, RunProjectBuild, UpdateProjectSettings, AddRole, DeleteRole, UpdateRoleDetails, ConfigureApiKeys, AddUser, DeleteUser, UpdateUserDetails): Available permission names. The names correspond to the following groups:

PermissionState

  • PermissionState object
    • allowed boolean: State of the named permission. true to allow, false to deny,
    • description string
    • name required PermissionName

PlatformName

  • PlatformName string (values: ARM, Any CPU, x64, x86)

Project

  • Project
    • accountName string
    • name string
    • projectId required integer
    • slug string
    • created string
    • updated string
    • accountId integer
    • alwaysBuildClosedPullRequests boolean
    • builds array: Only non-empty for response from getProjects.
    • currentBuildId integer
    • disablePullRequestWebhooks boolean
    • disablePushWebhooks boolean
    • enableDeploymentInPullRequests boolean
    • enableSecureVariablesInPullRequests boolean
    • enableSecureVariablesInPullRequestsFromSameRepo boolean
    • isGitHubApp boolean
    • isPrivate boolean
    • nuGetFeed NuGetFeed
    • repositoryBranch string: Not present in response from addProject.
    • repositoryName required string
    • repositoryScm RepositoryScm
    • repositoryType RepositoryProvider
    • rollingBuilds boolean
    • rollingBuildsDoNotCancelRunningBuilds boolean
    • rollingBuildsOnlyForPullRequests boolean
    • saveBuildCacheInPullRequests boolean
    • securityDescriptor SecurityDescriptor
    • skipBranchesWithoutAppveyorYml boolean
    • tags string: Comma-separated list of project tags for dynamic grouping.

ProjectAddition

  • ProjectAddition object: repositoryAuthentication is only used for git, mercurial, subversion repositoryProvider.
    • repositoryAuthentication RepositoryAuthenticationType
    • repositoryName required string: URL when repositoryProvider is git, mercurial, subversion username/project when repositoryProvider is gitHub
    • repositoryPassword string: Required if repositoryAuthentication is credentials
    • repositoryProvider required RepositoryProvider
    • repositoryUsername string: Required if repositoryAuthentication is credentials

ProjectBranchesMode

  • ProjectBranchesMode string (values: exclude, include)

ProjectBuildNumberUpdate

  • ProjectBuildNumberUpdate object
    • nextBuildNumber required integer

ProjectBuildResults

ProjectConfiguration

  • ProjectConfiguration object
    • afterBuildScripts array
    • afterDeployScripts array
    • afterTestScripts array
    • artifacts array
    • assemblyFileVersionFormat string
    • assemblyInfoFile string
    • assemblyInformationalVersionFormat string
    • assemblyVersionFormat string
    • beforeBuildScripts array
    • beforeDeployScripts array
    • beforePackageScripts array
    • beforeTestScripts array
    • branchesMode ProjectBranchesMode
    • buildCloud array
    • buildMode BuildMode
    • buildScripts array: Only set/used when buildMode is script.
    • cacheEntries array
    • cloneDepth integer
    • cloneFolder string
    • cloneScripts array
    • configuration array
    • configureNuGetAccountSource boolean
    • configureNuGetProjectSource boolean
    • deployMode DeployMode
    • deployScripts array
    • deployments array
    • disableNuGetPublishForOctopusPackages boolean
    • disableNuGetPublishOnPullRequests boolean
    • doNotIncrementBuildNumberOnPullRequests boolean
    • dotnetCsprojAssemblyVersionFormat string
    • dotnetCsprojFile string
    • dotnetCsprojFileVersionFormat string
    • dotnetCsprojInformationalVersionFormat string
    • dotnetCsprojPackageVersionFormat string
    • dotnetCsprojVersionFormat string
    • environmentVariables array
    • environmentVariablesMatrix array
    • excludeBranches array
    • forceHttpsClone boolean
    • hostsEntries array
    • hotFixScripts array
    • includeBranches array
    • includeNuGetReferences boolean
    • initScripts array
    • installScripts array
    • matrixAllowFailures array: Although the names and values are not enforced, the combinations which are meaningful are documented at https://www.appveyor.com/docs/build-configuration/#allow-failing-jobs
    • matrixExcept array
    • matrixExclude array
    • matrixFastFinish boolean
    • matrixOnly array
    • maxJobs integer
    • msBuildInParallel boolean
    • msBuildProjectFileName string
    • msBuildVerbosity MSBuildVerbosity
    • notifications array
    • onBuildErrorScripts array
    • onBuildFinishScripts array
    • onBuildSuccessScripts array
    • onlyCommitsFiles array
    • operatingSystem array
    • packageAspNetCoreProjects boolean
    • packageAzureCloudServiceProjects boolean
    • packageDotnetConsoleProjects boolean
    • packageNuGetProjects boolean
    • packageNuGetSymbols boolean
    • packageWebApplicationProjects boolean
    • packageWebApplicationProjectsBeanstalk boolean
    • packageWebApplicationProjectsOctopus boolean
    • packageWebApplicationProjectsXCopy boolean
    • patchAssemblyInfo boolean
    • patchDotnetCsproj boolean
    • platform array
    • services array
    • shallowClone boolean
    • skipBranchWithPullRequests boolean
    • skipCommitsFiles array
    • skipNonTags boolean
    • skipTags boolean
    • stacks array
    • testAssemblies array
    • testCategories array
    • testCategoriesMatrix array
    • testCategoriesMode string (values: exclude, include)
    • testMode TestMode
    • testScripts array: Only set/used when testMode is script.
    • xamarinRegisterAndroidProduct boolean
    • xamarinRegisterIosProduct boolean

ProjectDeployment

ProjectDeploymentModel

ProjectDeploymentsResults

ProjectHistory

ProjectLookupModel

  • ProjectLookupModel object
    • accountName string
    • name string
    • projectId required integer
    • slug string

ProjectSettingsResults

ProjectWithConfiguration

  • ProjectWithConfiguration object
    • accountName string
    • name string
    • projectId required integer
    • slug string
    • created string
    • updated string
    • accountId integer
    • alwaysBuildClosedPullRequests boolean
    • builds array: Only non-empty for response from getProjects.
    • currentBuildId integer
    • disablePullRequestWebhooks boolean
    • disablePushWebhooks boolean
    • enableDeploymentInPullRequests boolean
    • enableSecureVariablesInPullRequests boolean
    • enableSecureVariablesInPullRequestsFromSameRepo boolean
    • isGitHubApp boolean
    • isPrivate boolean
    • nuGetFeed NuGetFeed
    • repositoryBranch string: Not present in response from addProject.
    • repositoryName required string
    • repositoryScm RepositoryScm
    • repositoryType RepositoryProvider
    • rollingBuilds boolean
    • rollingBuildsDoNotCancelRunningBuilds boolean
    • rollingBuildsOnlyForPullRequests boolean
    • saveBuildCacheInPullRequests boolean
    • securityDescriptor SecurityDescriptor
    • skipBranchesWithoutAppveyorYml boolean
    • tags string: Comma-separated list of project tags for dynamic grouping.
    • buildPriority integer
    • configuration required ProjectConfiguration
    • customYmlName string
    • ignoreAppveyorYml boolean
    • nextBuildNumber integer
    • repositoryAuthentication RepositoryAuthenticationType
    • repositoryUsername string
    • scheduleCrontabExpression string: Build schedule as an NCrontab Expression. See https://github.com/atifaziz/NCrontab/wiki/Crontab-Expression
    • sshPublicKey string
    • statusBadgeId string
    • versionFormat required string
    • webhookId string
    • webhookUrl string

ReRunBuildRequest

  • ReRunBuildRequest object
    • buildId required integer
    • reRunIncomplete boolean: Set reRunIncomplete set to false (default value) for full build re-run. Set it set to true to rerun only failed or cancelled jobs in multijob build.

RepositoryAuthenticationType

  • RepositoryAuthenticationType string (values: credentials, ssh)

RepositoryProvider

  • RepositoryProvider string (values: bitBucket, git, gitHub, gitLab, kiln, mercurial, stash, subversion, vso)

RepositoryScm

  • RepositoryScm string (values: git, mercurial, subversion)

Role

  • Role: Technically roleId has default value 0 and is not required, but
    • created string
    • updated string
    • isSystem boolean
    • name required string
    • roleId required integer

RoleAce

  • RoleAce object
    • accessRights array
    • isAdmin boolean
    • name string
    • roleId integer

RoleAddition

  • RoleAddition object
    • name required string

RoleWithGroups

  • RoleWithGroups
    • created string
    • updated string
    • isSystem boolean
    • name required string
    • roleId required integer
    • groups array

Script

ScriptLanguage

  • ScriptLanguage string (values: cmd, ps, pwsh, sh)

SecurityDescriptor

Status

  • Status string (values: cancelled, cancelling, failed, queued, running, starting, success)

StoredNameValue

  • StoredNameValue object

StoredNameValueMatrix

StoredValue

  • StoredValue object
    • isEncrypted boolean
    • value string: Encrypted values can be created using the encryptValue operation.

StringValueObject

  • StringValueObject object
    • value string

TestMode

  • TestMode string (values: auto, none, script)

Timestamped

  • Timestamped object
    • created string
    • updated string

UnknownType

  • UnknownType string (values: unknown): A schema for values which have an undocumented/unknown type.

UserAccount

  • UserAccount
    • created string
    • updated string
    • accountId integer
    • accountName string
    • email required string
    • fullName required string
    • isCollaborator boolean
    • isOwner boolean
    • pageSize integer
    • password string
    • roleId integer
    • roleName string
    • twoFactorAuthEnabled boolean
    • userId integer

UserAccountRolesResults

  • UserAccountRolesResults object: The roles property contains all roles, not only the role for which the user is a member.

UserAccountSettings

UserAddition

  • UserAddition object
    • confirmPassword string
    • email required string
    • fullName required string
    • generatePassword boolean
    • password string
    • roleId required integer: Technically roleId has default value 0 and is not required, but
datafire
@everything-registry/sub-chunk-220@infinitebrahmanuniverse/nolb-_datafire_ap
6.0.0

5 years ago

5.0.0

7 years ago

4.0.0

7 years ago

3.0.0

8 years ago

2.0.3

8 years ago

2.0.2

8 years ago

2.0.1

8 years ago

2.0.0

8 years ago