forked from Azure/azure-rest-api-specs
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' of https://github.com/Azure/azure-rest-api-specs …
…into add_endpoint * 'main' of https://github.com/Azure/azure-rest-api-specs: (5079 commits) Add Microsoft.ExtendedLocation [CustomLocation] 2021-08-15 stable API Version (Azure#15967) Updated SKU property to be read only (Azure#15965) Add Microsoft.Communication.UserDisconnected Event (Azure#15870) Add collection APIs (Azure#15221) [Cognitive Services - Personalizer] v1.1-preview.2 (Azure#15699) Adding default error response & updating basePath (Azure#15784) Update readme and readme.python (Azure#15973) add synapse batch tag package-composite-v1 (Azure#15974) Microsoft.BareMetalInfrastructure: add stable API version 2021-08-09 (Azure#15680) change readme.go.md template to track 2 (Azure#15972) [CosmosDB] Adding apiVersion 2021-07-01-preview (Azure#14817) Merge Dev-containerservice-microsoft.containerservice-2021-08-01 branch to main (Azure#15954) DiskRP swagger for 2021-04-01 (Azure#15665) Use IncidentSeverity in IncidentInfo (Azure#15762) Add stable API version "2021-09-01" (Azure#15897) add-purview-typescript-file (Azure#15948) Swagger Completeness for Microsoft.Authorization (Azure#15253) [Hub Generated] Review request for Microsoft.Aadiam to add version preview/2020-03-01-preview and stable/2020-03-01 (Azure#15861) Add swagger for missing CheckPolicyRestrictions API version (Azure#15888) Add Red Hat OpenShift 2021-09-01-preview (Azure#15616) ...
- Loading branch information
Showing
47,245 changed files
with
7,014,362 additions
and
136,963 deletions.
The diff you're trying to view is too large. We only load the first 3000 changed files.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
jobs: | ||
- job: "BranchProtectionForPrivateRepo" | ||
pool: | ||
vmImage: 'Ubuntu 16.04' | ||
condition: and(variables['PRIVATE'], eq(variables['System.PullRequest.TargetBranch'], 'main')) | ||
steps: | ||
- script: '>&2 echo "the branch is protected"' | ||
failOnStderr: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
jobs: | ||
- job: "NetworkValidation" | ||
condition: and(startsWith(variables['System.PullRequest.TargetBranch'], 'network-'), endsWith(variables['System.PullRequest.TargetBranch'], '-release')) | ||
continueOnError: true | ||
pool: | ||
vmImage: vs2017-win2016 | ||
variables: | ||
NRP_SWAGGER_VALIDATION_OVERRIDE_PS_BRANCH: 'true' | ||
NRP_BUILD_TOOLS_SKIP_GENERATE_PS1: 'true' | ||
NRP_BUILD_TOOLS_OUTPUT_PATH: '$(System.DefaultWorkingDirectory)\Out' | ||
steps: | ||
- powershell: | | ||
& "C:/Program Files (x86)/Microsoft SDKs/Windows/v10.0A/bin/NETFX 4.6.1 Tools/sn.exe" -Vr *,31bf3856ad364e35 | ||
displayName: Bypass Strong Name validation | ||
- task: NodeTool@0 | ||
inputs: | ||
versionSpec: '10.16.3' | ||
displayName: Install Node.js | ||
- script: npm install autorest -g | ||
displayName: Install autorest | ||
- script: git clone --depth 1 -- https://dev.azure.com/nrp-swagger/swagger-stack/_git/automation-scripts ..\BuildScripts | ||
displayName: Clone build tools | ||
- powershell: | | ||
$swgrPath = (Get-Item ".\").FullName | ||
$outputPath = $env:NRP_BUILD_TOOLS_OUTPUT_PATH | ||
New-Item -Path $outputPath -ItemType "Directory" -Force | Out-Null | ||
..\BuildScripts\Test-SwaggerRelease.ps1 -Component Network -SwaggerRepoPath $swgrPath -OutputFolder $outputPath | ||
failOnStderr: false | ||
displayName: Test Swagger updates | ||
- powershell: | | ||
Copy-Item "..\BuildScripts\.azure-pipelines\.artifactignore" -Destination "$($env:NRP_BUILD_TOOLS_OUTPUT_PATH)\.artifactignore" -Force -ErrorAction "SilentlyContinue" | ||
failOnStderr: false | ||
condition: always() | ||
displayName: Copy .artifactignore | ||
- task: PublishPipelineArtifact@0 | ||
condition: always() | ||
inputs: | ||
artifactName: SwaggerTestOutput | ||
targetPath: $(NRP_BUILD_TOOLS_OUTPUT_PATH) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
jobs: | ||
- job: "ShouldSendPRToMain" | ||
pool: | ||
vmImage: 'Ubuntu 16.04' | ||
condition: eq(variables['System.PullRequest.TargetBranch'], 'master') | ||
steps: | ||
- script: '>&2 echo "##vso[task.logissue type=error]Please edit the pull request to targeting new default branch main"' | ||
failOnStderr: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
jobs: | ||
- job: "SDK" | ||
timeoutInMinutes: 180 | ||
strategy: | ||
matrix: | ||
java: | ||
AZURE_SDK_REPO: azure-sdk-for-java | ||
AZURE_SDK_PARAMS: '' | ||
javascript: | ||
AZURE_SDK_REPO: azure-sdk-for-js | ||
AZURE_SDK_PARAMS: '' | ||
python: | ||
AZURE_SDK_REPO: azure-sdk-for-python | ||
AZURE_SDK_PARAMS: '' | ||
cliextension: | ||
AZURE_SDK_REPO: azure-cli-extensions | ||
AZURE_SDK_PARAMS: '' | ||
trenton: | ||
AZURE_SDK_REPO: azure-sdk-for-trenton | ||
AZURE_SDK_PARAMS: '' | ||
go: | ||
AZURE_SDK_REPO: azure-sdk-for-go | ||
AZURE_SDK_PARAMS: '-o latest' | ||
pool: | ||
vmImage: 'Ubuntu 16.04' | ||
variables: | ||
NODE_OPTIONS: '--max-old-space-size=8192' | ||
steps: | ||
- script: echo $(NODE_OPTIONS) | ||
- script: "scripts/swagger-to-sdk.sh Azure/$(AZURE_SDK_REPO) -v $(AZURE_SDK_PARAMS)" | ||
displayName: "Swagger to SDK script" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
schedules: | ||
- cron: "0 0 * * *" | ||
displayName: Daily build | ||
branches: | ||
include: | ||
- main | ||
always: true | ||
|
||
pool: | ||
vmImage: 'Ubuntu-16.04' | ||
|
||
variables: | ||
IMAGE_TAG_PREFIX: $[format('1.0.{0:HHm}', pipeline.startTime)] | ||
|
||
steps: | ||
- task: Docker@2 | ||
displayName: Login to production ACR | ||
inputs: | ||
command: login | ||
containerRegistry: $(CONTAINER_REGISTRY_SERVICE_CONNECTION) | ||
|
||
- task: Docker@2 | ||
displayName: Login to dogfood ACR | ||
inputs: | ||
command: login | ||
containerRegistry: $(DOGFOOD_CONTAINER_REGISTRY_SERVICE_CONNECTION) | ||
|
||
- task: CopyFiles@2 | ||
inputs: | ||
SourceFolder: $(Build.SourcesDirectory) | ||
contents: .git/** | ||
targetFolder: $(Build.SourcesDirectory)/scripts/datacontainer | ||
|
||
- task: Docker@2 | ||
displayName: Build and Push | ||
inputs: | ||
command: buildAndPush | ||
Dockerfile: scripts/datacontainer/Dockerfile | ||
repository: $(CONTAINER_REGISTRY_REPOSITORY_NAME) | ||
tags: | | ||
latest |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,3 @@ | ||
### *This is an outdated document. Please refer the new [wiki](https://github.com/Azure/adx-documentation-pr/wiki) for up to date details.* | ||
### *This is an outdated document. Please refer the new [wiki](https://github.com/Azure/azure-rest-api-specs/wiki) for up to date details.* | ||
([`Link your GitHub account`](https://repos.opensource.microsoft.com/) to the 'Azure' organization for access.) | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,17 +1,62 @@ | ||
### Latest improvements: | ||
<i>MSFT employees can try out our new experience at <b>[OpenAPI Hub](https://aka.ms/openapiportal) </b> - one location for using our validation tools and finding your workflow. | ||
</i><br> | ||
</i> | ||
|
||
### Changelog | ||
Add a changelog entry for this PR by answering the following questions: | ||
1. What's the purpose of the update? | ||
- [ ] new service onboarding | ||
- [ ] new API version | ||
- [ ] update existing version for new feature | ||
- [ ] update existing version to fix swagger quality issue in s360 | ||
- [ ] Other, please clarify | ||
2. When are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month. | ||
3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month. | ||
4. If updating an existing version, please select the specific langauge SDKs and CLIs that must be refreshed after the swagger is published. | ||
- [ ] SDK of .NET (need service team to ensure code readiness) | ||
- [ ] SDK of Python | ||
- [ ] SDK of Java | ||
- [ ] SDK of Js | ||
- [ ] SDK of Go | ||
- [ ] PowerShell | ||
- [ ] CLI | ||
- [ ] Terraform | ||
- [ ] No refresh required for updates in this PR | ||
|
||
### Contribution checklist: | ||
- [ ] I have reviewed the [documentation](https://github.com/Azure/azure-rest-api-specs#basics) for the workflow. | ||
- [ ] [Validation tools](https://github.com/Azure/azure-rest-api-specs/blob/master/documentation/swagger-checklist.md#validation-tools-for-swagger-checklist) were run on swagger spec(s) and have all been fixed in this PR. | ||
- [ ] The [OpenAPI Hub](https://aka.ms/openapiportal) was used for checking validation status and next steps. | ||
### ARM API Review Checklist | ||
- [ ] Service team MUST add the "WaitForARMFeedback" label if the management plane API changes fall into one of the below categories. | ||
- adding/removing APIs. | ||
- adding/removing properties. | ||
- adding/removing API-version. | ||
- adding a new service in Azure. | ||
|
||
Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs. | ||
- [ ] If you are blocked on ARM review and want to get the PR merged urgently, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them. | ||
Please follow the link to find more details on [API review process](https://armwiki.azurewebsites.net/rp_onboarding/ResourceProviderOnboardingAPIRevieworkflow.html). | ||
- [ ] I commit to follow the [Breaking Change Policy](http://aka.ms/bcforapi) of "no breaking changes" | ||
- [ ] I have reviewed the [documentation](https://aka.ms/ameonboard) for the workflow. | ||
- [ ] [Validation tools](https://aka.ms/swaggertools) were run on swagger spec(s) and errors have all been fixed in this PR. [How to fix?](https://aka.ms/ci-fix) | ||
|
||
If any further question about AME onboarding or validation tools, please view the [FAQ](https://aka.ms/faqinprreview). | ||
|
||
### ARM API Review Checklist | ||
|
||
> **Applicability**: :warning: | ||
> | ||
> If your changes encompass only the following scenarios, you should SKIP this section, as these scenarios do not require ARM review. | ||
> - Change to data plane APIs | ||
> - Adding new properties | ||
> - All removals | ||
Otherwise your PR may be subject to ARM review requirements. Complete the following: | ||
- [ ] Check this box if any of the following apply to the PR so that label “WaitForARMFeedback” will be added automatically to begin ARM API Review. Failure to comply may result in delays to the manifest. | ||
- Adding a new service | ||
- Adding new API(s) | ||
- Adding a new API version | ||
-[ ] To review changes efficiently, ensure you copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits. | ||
|
||
- [ ] Ensure you've reviewed following [guidelines](https://aka.ms/rpguidelines) including [ARM resource provider contract](https://github.com/Azure/azure-resource-manager-rpc) and [REST guidelines](https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md). Estimated time (4 hours). This is required before you can request review from ARM API Review board. | ||
|
||
- [ ] If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (*RP Manifest Approvers* team under <ins>Azure Resource Manager service</ins>) from IcM and reach out to them. | ||
|
||
### Breaking Change Review Checklist | ||
If any of the following scenarios apply to the PR, request approval from the Breaking Change Review Board as defined in the [Breaking Change Policy](http://aka.ms/bcforapi). | ||
- [ ] Removing API(s) in a stable version | ||
- [ ] Removing properties in a stable version | ||
- [ ] Removing API version(s) in a stable version | ||
- [ ] Updating API in a stable or public preview version with Breaking Change Validation errors | ||
- [ ] Updating API(s) in public preview over 1 year (refer to [Retirement of Previews](https://dev.azure.com/msazure/AzureWiki/_wiki/wikis/AzureWiki.wiki/37683/Retirement-of-Previews)) | ||
|
||
**Action**: to initiate an evaluation of the breaking change, create a new intake using the [template for breaking changes](https://aka.ms/Breakingchangetemplate). Addition details on the process and office hours are on the [Breaking change Wiki](https://dev.azure.com/msazure/AzureWiki/_wiki/wikis/AzureWiki.wiki/37684/Breaking-Changes). | ||
|
||
Please follow the link to find more details on [PR review process](https://aka.ms/SwaggerPRReview). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,64 @@ | ||
--- | ||
- rule: | ||
type: checkbox | ||
keywords: | ||
- "WaitForARMFeedback" | ||
booleanFilterExpression: "!(ARMSignedOff||ARMChangesRequested||Approved-OkToMerge||WaitForARMRevisit)" | ||
onCheckedLabels: | ||
- WaitForARMFeedback | ||
onCheckedComments: "Hi, @${PRAuthor} your PR are labelled with <b> WaitForARMFeedback</b>. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com)." | ||
|
||
- rule: | ||
type: label | ||
label: BreakingChangeReviewRequired | ||
variables: | ||
openapiHub: https://portal.azure-devex-tools.com | ||
onLabeledComments: "Hi @${PRAuthor}, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow [breaking change policy](https://aka.ms/AzBreakingChangesPolicy) to request breaking change review and approval before proceeding swagger PR review. </br>**Action**: To initiate an evaluation of the breaking change, create a new intake using the [template for breaking changes](https://aka.ms/Breakingchangetemplate). Addition details on the process and office hours are on the [Breaking change Wiki](https://dev.azure.com/msazure/AzureWiki/_wiki/wikis/AzureWiki.wiki/37684/Breaking-Changes).</br> If you want to know the production traffic statistic, please see [ARM Traffic statistic](${openapiHub}/api/pr/query-traffic?pr=${owner}/${repo}/${PRNumber}&days=5). </br> If you think it is false positive breaking change, please provide the reasons in the PR comment, report to Swagger Tooling Team via https://aka.ms/swaggerfeedback." | ||
|
||
- rule: | ||
type: label | ||
repoAllowList: | ||
- Azure/azure-rest-api-specs-pr | ||
variables: | ||
openapiHub: https://portal.azure-devex-tools.com | ||
to: Azure/azure-rest-api-specs/master | ||
label: Approved-OkToMerge | ||
onLabeledComments: "Hi @${PRAuthor},Your PR is approved. Congratulations. </br> <li> Since your PR is in private repo (azure-rest-api-specs-pr), there won’t be PR merge. If you want to publish the PR to public repo (Azure/azure-rest-api-specs) and get it merged, pls use [OpenAPIHub Publish PR](${openapiHub}/tools/publishpullrequest?pr=${owner}/${repo}/${PRNumber}&to=${to}).</li> <li> For further guidance on how to proceed. Please refer to this [wiki](https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/205/RP-Scenarios-to-Contribute-to-Swagger?anchor=**public-repository-vs.-private-repository**)</li>" | ||
|
||
- rule: | ||
type: label | ||
label: NewApiVersionRequired | ||
onLabeledComments: "<b>NewApiVersionRequired reason:</b></br> </br><b>A service’s API is a contract with customers and is represented by using the api-version query parameter. Changes such as adding an optional property to a request/response or introducing a new operation is a change to the service’s contract and therefore requires a new api-version value. This is critically important for documentation, client libraries, and customer support. </b> </br></br> EXAMPLE: if a customer calls a service in the public cloud using <b>api-version=2020-07-27</b>, the new property or operation may exist but if they call the service in a government cloud, air-gapped cloud, or Azure Stack Hub cloud using the same api-version, the property or operation may not exist. Because there is no clear relationship between the service api-version and the new property/operation, customers can’t trust the documentation and Azure customer have difficulty helping customers diagnose issues. In addition, each client library version documents the service version it supports. When an optional property or new operation is added to a service and its Swagger, new client libraries must be produced to expose this functionality to customers. Without updating the api-version, it is unclear to customers which version of a client library supports these new features. " | ||
|
||
- rule: | ||
type: label | ||
label: CI-FixRequiredOnFailure | ||
onLabeledComments: >- | ||
Hi @${PRAuthor}, Your PR has some issues. Please fix the CI sequentially by following the order of `Avocado, semantic validation, model validation, breaking change, lintDiff`. | ||
<table><tr><th>Task</th><th>How to fix</th><th>Priority</th><th>Support (Microsoft alias)</th></tr> | ||
<tr><td>Avocado</td><td>[Fix-Avocado](https://github.com/Azure/avocado)</td><td>High</td><td>ruowan</td></tr> | ||
<tr><td>Semantic validation</td><td>[Fix-SemanticValidation-Error](https://github.com/Azure/azure-rest-api-specs/blob/master/documentation/ci-fix.md#semantic-validation)</td><td>High</td><td>raychen, jianyxi</td></tr> | ||
<tr><td>Model validation</td><td>[Fix-ModelValidation-Error](https://github.com/Azure/azure-rest-api-specs/blob/master/documentation/ci-fix.md#model-validation)</td><td>High</td><td>raychen,jianyxi</td></tr> | ||
<tr><td>LintDiff</td><td>[Fix-LintDiff](https://github.com/Azure/azure-rest-api-specs/blob/master/documentation/ci-fix.md#linter-validation)</td><td>high</td><td>jianyxi, ruoxuan</td></tr></table> | ||
If you need further help, please feedback via [swagger feedback](https://aka.ms/swaggerfeedback)." | ||
- rule: | ||
type: PROpen | ||
variables: | ||
openapiHub: https://portal.azure-devex-tools.com | ||
keywords: | ||
- "I have reviewed the [documentation](https://aka.ms/ameonboard) for the workflow." | ||
onOpenedComments: "Hi, @${PRAuthor} Thanks for your PR. I am workflow bot for review process. Here are some small tips. </br> <li> Please ensure to do self-check against checklists in first PR comment.</li> <li> PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging. </li> <li> For specs comparison cross API versions, Use [API Specs Comparison Report Generator](${openapiHub}/tools/diff?pr=${owner}/${repo}/${PRNumber})</li> <li> If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. [How to fix?](https://github.com/Azure/azure-rest-api-specs/blob/master/documentation/ci-fix.md)</li></br> Any feedback about review process or workflow bot, pls contact swagger and tools team. vsswagger@microsoft.com" | ||
|
||
- rule: | ||
type: PROpen | ||
onOpenedComments: "[Call for Action] To better understand Azure service dev/test scenario, and support Azure service developer better on Swagger and REST API related tests in early phase, please help to fill in with this survey https://aka.ms/SurveyForEarlyPhase. It will take 5 to 10 minutes. If you already complete survey, please neglect this comment. Thanks." | ||
|
||
|
||
- rule: | ||
type: checkbox | ||
keywords: | ||
- "update existing version to fix swagger quality issue in s360" | ||
onCheckedLabels: | ||
- FixS360 | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
--- | ||
- rule: | ||
booleanFilterExpression: "needs-triage" | ||
assignees: | ||
- raych1 | ||
- akning-ms | ||
- leni-msft | ||
- ruowan | ||
- jianyexi | ||
- zhenglaizhang | ||
|
Oops, something went wrong.