Skip to content

Commit

Permalink
Actual changes to api spec for new version
Browse files Browse the repository at this point in the history
  • Loading branch information
@suyash691
suyash691 committed Nov 9, 2020
1 parent 22581c5 commit 0e38886
Show file tree
Hide file tree
Showing 15 changed files with 243 additions and 57 deletions.
132 changes: 91 additions & 41 deletions ...ification/devops/resource-manager/Microsoft.DevOps/preview/2020-07-13-preview/devops.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"info": {
"title": "Azure DevOps",
"description": "Azure DevOps Resource Provider",
"version": "2019-07-01-preview",
"version": "2020-07-13-preview",
"x-ms-code-generation-settings": {
"name": "DevOpsClient"
}
Expand Down Expand Up @@ -79,7 +79,7 @@
"PipelineTemplateDefinitions"
],
"operationId": "PipelineTemplateDefinitions_List",
"description": "Lists all pipeline templates which can be used to configure an Azure Pipeline.",
"description": "Lists all pipeline templates which can be used to configure a Pipeline.",
"parameters": [
{
"$ref": "#/parameters/ApiVersionParameter"
Expand Down Expand Up @@ -115,7 +115,7 @@
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevOps/pipelines/{pipelineName}": {
"put": {
"operationId": "Pipelines_CreateOrUpdate",
"description": "Creates or updates an Azure Pipeline.",
"description": "Creates or updates a Pipeline.",
"tags": [
"Pipelines"
],
Expand All @@ -131,15 +131,15 @@
},
{
"name": "pipelineName",
"description": "The name of the Azure Pipeline resource in ARM.",
"description": "The name of the Pipeline resource in ARM.",
"in": "path",
"type": "string",
"required": true,
"x-ms-parameter-location": "method"
},
{
"name": "createOperationParameters",
"description": "The request payload to create the Azure Pipeline.",
"description": "The request payload to create the Pipeline.",
"in": "body",
"required": true,
"schema": {
Expand All @@ -149,10 +149,10 @@
],
"responses": {
"202": {
"description": "The request has been accepted for processing and the Azure Pipeline will be configured asynchronously."
"description": "The request has been accepted for processing and the Pipeline will be configured asynchronously."
},
"200": {
"description": "The Azure Pipeline has been configured successfully.",
"description": "The Pipeline has been configured successfully.",
"schema": {
"$ref": "#/definitions/Pipeline"
}
Expand All @@ -168,12 +168,15 @@
"x-ms-examples": {
"Create an Azure pipeline to deploy a sample ASP.Net application to Azure web-app": {
"$ref": "./examples/CreateAzurePipeline-Sample-AspNet-WindowsWebApp.json"
},
"Create a GitHub pipeline to deploy a sample ASP.Net application to Azure web-app": {
"$ref": "./examples/CreateGitHubPipeline-Sample-AspNet-WindowsWebApp.json"
}
}
},
"get": {
"operationId": "Pipelines_Get",
"description": "Gets an existing Azure Pipeline.",
"description": "Gets an existing Pipeline.",
"tags": [
"Pipelines"
],
Expand All @@ -189,7 +192,7 @@
},
{
"name": "pipelineName",
"description": "The name of the Azure Pipeline resource in ARM.",
"description": "The name of the Pipeline resource in ARM.",
"in": "path",
"type": "string",
"required": true,
Expand All @@ -198,7 +201,7 @@
],
"responses": {
"200": {
"description": "The Azure Pipeline has been fetched successfully.",
"description": "The Pipeline has been fetched successfully.",
"schema": {
"$ref": "#/definitions/Pipeline"
}
Expand All @@ -211,14 +214,14 @@
}
},
"x-ms-examples": {
"Get an existing Azure pipeline": {
"$ref": "./examples/GetAzurePipeline.json"
"Get an existing pipeline": {
"$ref": "./examples/GetPipeline.json"
}
}
},
"patch": {
"operationId": "Pipelines_Update",
"description": "Updates the properties of an Azure Pipeline. Currently, only tags can be updated.",
"description": "Updates the properties of an Azure Pipeline. Currently, it is not supported on 'githubWorkflow' pipeline type and only tags can be updated for 'azurePipeline' pipeline type.",
"tags": [
"Pipelines"
],
Expand Down Expand Up @@ -265,14 +268,14 @@
}
},
"x-ms-examples": {
"Get an existing Azure pipeline": {
"Update an existing Azure pipeline": {
"$ref": "./examples/UpdateAzurePipeline.json"
}
}
},
"delete": {
"operationId": "Pipelines_Delete",
"description": "Deletes an Azure Pipeline.",
"description": "Deletes a Pipeline.",
"tags": [
"Pipelines"
],
Expand All @@ -288,7 +291,7 @@
},
{
"name": "pipelineName",
"description": "The name of the Azure Pipeline resource.",
"description": "The name of the Pipeline resource.",
"in": "path",
"type": "string",
"required": true,
Expand All @@ -297,10 +300,10 @@
],
"responses": {
"200": {
"description": "The Azure Pipeline has been deleted successfully."
"description": "The Pipeline has been deleted successfully."
},
"204": {
"description": "The Azure Pipeline is not found or has been deleted already."
"description": "The Pipeline is not found or has been deleted already."
},
"default": {
"description": "Error response describing why the operation failed.",
Expand All @@ -310,16 +313,16 @@
}
},
"x-ms-examples": {
"Get an existing Azure pipeline": {
"$ref": "./examples/DeleteAzurePipeline.json"
"Delete an existing pipeline": {
"$ref": "./examples/DeletePipeline.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevOps/pipelines": {
"get": {
"operationId": "Pipelines_ListByResourceGroup",
"description": "Lists all Azure Pipelines under the specified resource group.",
"description": "Lists all Pipelines under the specified resource group.",
"tags": [
"Pipelines"
],
Expand All @@ -336,7 +339,7 @@
],
"responses": {
"200": {
"description": "The Azure Pipelines have been fetched successfully.",
"description": "The Pipelines have been fetched successfully.",
"schema": {
"$ref": "#/definitions/PipelineListResult"
}
Expand All @@ -352,16 +355,16 @@
"nextLinkName": "nextLink"
},
"x-ms-examples": {
"List all Azure Pipelines under the specified resource group": {
"$ref": "./examples/ListAzurePipelinesByResourceGroup.json"
"List all Pipelines under the specified resource group": {
"$ref": "./examples/ListPipelinesByResourceGroup.json"
}
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.DevOps/pipelines": {
"get": {
"operationId": "Pipelines_ListBySubscription",
"description": "Lists all Azure Pipelines under the specified subscription.",
"description": "Lists all Pipelines under the specified subscription.",
"tags": [
"Pipelines"
],
Expand All @@ -375,7 +378,7 @@
],
"responses": {
"200": {
"description": "The Azure Pipelines have been fetched successfully.",
"description": "The Pipelines have been fetched successfully.",
"schema": {
"$ref": "#/definitions/PipelineListResult"
}
Expand All @@ -391,8 +394,8 @@
"nextLinkName": "nextLink"
},
"x-ms-examples": {
"List all Azure pipelines under the specified subscription": {
"$ref": "./examples/ListAzurePipelinesBySubscription.json"
"List all pipelines under the specified subscription": {
"$ref": "./examples/ListPipelinesBySubscription.json"
}
}
}
Expand Down Expand Up @@ -592,7 +595,7 @@
},
"Pipeline": {
"type": "object",
"description": "Azure DevOps Pipeline used to configure Continuous Integration (CI) & Continuous Delivery (CD) for Azure resources.",
"description": "Pipeline used to configure Continuous Integration (CI) & Continuous Delivery (CD) for Azure resources.",
"properties": {
"properties": {
"$ref": "#/definitions/PipelineProperties",
Expand All @@ -612,29 +615,76 @@
"PipelineProperties": {
"type": "object",
"description": "Custom properties of a Pipeline.",
"discriminator": "pipelineType",
"properties": {
"pipelineId": {
"type": "integer",
"readOnly": true,
"description": "Unique identifier of the Azure Pipeline within the Azure DevOps Project."
"description": "Unique identifier of the Pipeline"
},
"pipelineType": {
"type": "string",
"enum": [
"githubWorkflow",
"azurePipeline"
],
"x-ms-enum": {
"name": "pipelineTypeEnum",
"modelAsString": true
},
"description": "Specifies which CI/CD provider to use. Valid options are 'azurePipeline', 'githubWorkflow'."
},
"bootstrapConfiguration": {
"$ref": "#/definitions/BootstrapConfiguration",
"description": "Configuration used to bootstrap the Pipeline."
}
},
"required": [
"pipelineType",
"bootstrapConfiguration"
]
},
"azurePipelineProperties": {
"type": "object",
"x-ms-discriminator-value": "azurePipeline",
"description": "Custom properties of a Azure Pipeline.",
"properties": {
"organization": {
"$ref": "#/definitions/OrganizationReference",
"description": "Reference to the Azure DevOps Organization containing the Pipeline."
"description": "Reference to the Azure DevOps Organization containing the Pipeline. Required for 'azurePipeline' pipeline type."
},
"project": {
"$ref": "#/definitions/ProjectReference",
"description": "Reference to the Azure DevOps Project containing the Pipeline."
},
"bootstrapConfiguration": {
"$ref": "#/definitions/BootstrapConfiguration",
"description": "Configuration used to bootstrap the Pipeline."
"description": "Reference to the Azure DevOps Project containing the Pipeline. Required for 'azurePipeline' pipeline type."
}
},
"allOf": [
{
"$ref": "#/definitions/PipelineProperties"
}
],
"required": [
"organization",
"project",
"bootstrapConfiguration"
"project"
]
},
"githubWorkflowProperties": {
"type": "object",
"x-ms-discriminator-value": "githubWorkflow",
"description": "Custom properties of an Github Pipeline.",
"properties": {
"repository": {
"$ref": "#/definitions/CodeRepository",
"description": "Contains the specifications of the repository to be created for generating the workflow. Required for 'githubWorkflow' pipeline type."
}
},
"allOf": [
{
"$ref": "#/definitions/PipelineProperties"
}
],
"required": [
"repository"
]
},
"OrganizationReference": {
Expand Down Expand Up @@ -677,9 +727,9 @@
"type": "object",
"description": "Configuration used to bootstrap a Pipeline.",
"properties": {
"repository": {
"sourceRepository": {
"$ref": "#/definitions/CodeRepository",
"description": "Repository containing the source code for the pipeline."
"description": "Repository containing the source code for the pipeline. Currently only 'azurePipeline' pipeline type supports this."
},
"template": {
"$ref": "#/definitions/PipelineTemplate",
Expand Down Expand Up @@ -827,7 +877,7 @@
}
},
"PipelineListResult": {
"description": "Result of a request to list all Azure Pipelines under a given scope.",
"description": "Result of a request to list all Pipelines under a given scope.",
"properties": {
"value": {
"description": "List of pipelines.",
Expand Down
6 changes: 4 additions & 2 deletions .../preview/2020-07-13-preview/examples/CreateAzurePipeline-Sample-AspNet-WindowsWebApp.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,12 @@
"subscriptionId": "{subscriptionId}",
"resourceGroupName": "myAspNetWebAppPipeline-rg",
"pipelineName": "myAspNetWebAppPipeline",
"api-version": "2019-07-01-preview",
"api-version": "2020-07-13-preview",
"createOperationParameters": {
"location": "South India",
"tags": {},
"properties": {
"pipelineType": "azurePipeline",
"organization": {
"name": "myAspNetWebAppPipeline-org"
},
Expand Down Expand Up @@ -40,13 +41,14 @@
}
},
"200": {
"description": "The Azure Pipeline has been configured successfully.",
"description": "The Pipeline has been configured successfully.",
"body": {
"id": "/subscriptions/{subscriptionId}/resourceGroups/myAspNetWebAppPipeline-rg/providers/Microsoft.DevOps/pipelines/myAspNetWebAppPipeline",
"name": "myAspNetWebAppPipeline",
"type": "Microsoft.DevOps/pipelines",
"location": "South India",
"properties": {
"pipelineType": "azurePipeline",
"organization": {
"name": "myAspNetWebAppPipeline-org"
},
Expand Down
Loading

0 comments on commit 0e38886

Please sign in to comment.