Merge pull request #8 from Azure/master

Merge master

.azure-pipelines/BranchProtectionForPrivateRepo.yml

@@ -0,0 +1,8 @@
+jobs:
+  - job: "BranchProtectionForPrivateRepo"
+    pool:
+      vmImage: 'Ubuntu 16.04'
+    condition: and(variables['PRIVATE'], eq(variables['System.PullRequest.TargetBranch'], 'master'))
+    steps:
+    - script: '>&2 echo "the branch is protected"'
+      failOnStderr: true

.azure-pipelines/NetworkValidation.yml

@@ -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)

.azure-pipelines/PrettierCheck.yml

@@ -0,0 +1,14 @@
+jobs:
+- job: "PrettierCheck"
+  variables:
+    NODE_OPTIONS: '--max-old-space-size=8192'
+  pool:
+    vmImage: 'Ubuntu 18.04'
+  continueOnError: true
+  steps:
+  - task: Npm@1
+    displayName: 'npm install'
+    inputs:
+      verbose: false
+  - script: 'npm run prettier-check'
+    displayName: 'Run Prettier Check'

.azure-pipelines/SDKAutomation.yml

@@ -0,0 +1,94 @@
+trigger:
+  batch: false
+  branches:
+    include:
+      - master
+
+pr:
+  autoCancel: false
+
+variables:
+  IMAGE: azopenapi.azurecr.io/openapi/sdk-automation:prod
+  REGISTRY_ENDPOINT: azopenapi-registry
+
+jobs:
+- job: "SDKAutomation"
+  displayName: SDK
+  pool:
+    vmImage: 'Ubuntu 18.04'
+  timeoutInMinutes: 180
+
+  variables:
+      NODE_OPTIONS: '--max-old-space-size=8192'
+      SPEC_REPO: $(Build.Repository.Name)
+      PR_NUMBER: $(System.PullRequest.PullRequestNumber)
+      BUILD_ID: $(Build.BuildId)
+  strategy:
+    matrix:
+      Net:
+        SDK_REPO_NAME: azure-sdk-for-net
+      Java:
+        SDK_REPO_NAME: azure-sdk-for-java
+      JavaScript:
+        SDK_REPO_NAME: azure-sdk-for-js
+      Python:
+        SDK_REPO_NAME: azure-sdk-for-python
+      PythonT2:
+        SDK_REPO_NAME: azure-sdk-for-python-track2
+      Cliextension:
+        SDK_REPO_NAME: azure-cli-extensions
+      Go:
+        SDK_REPO_NAME: azure-sdk-for-go
+      Trenton:
+        SDK_REPO_NAME: azure-sdk-for-trenton
+      Schema:
+        SDK_REPO_NAME: azure-resource-manager-schemas
+  steps:
+  - checkout: none
+  - script: |
+      curl \
+        -s https://api.github.com/repos/$(Build.Repository.Name)/commits/$(Build.SourceVersion)/pulls \
+        -H "Accept: application/vnd.github.groot-preview+json" \
+      | python3 -c "import sys,json; a=json.load(sys.stdin); print(f'##vso[task.setvariable variable=PR_NUMBER]{a[0][\"number\"]}' if len(a)>0 and a[0][\"base\"][\"ref\"]=='master' else '##vso[task.logissue type=error]Last commit $(Build.SourceVersion) doesnot have a related PR')"
+    displayName: Get PR_NUMBER
+    condition: in(variables['Build.Reason'], 'IndividualCI', 'Manual')
+  - task: Docker@2
+    displayName: Login into ACR
+    inputs:
+      command: login
+      containerRegistry: $(REGISTRY_ENDPOINT)
+  - script: |
+      docker pull $IMAGE
+      docker tag $IMAGE sdk-automation:latest
+    displayName: Pull SDK Automation Image
+  - script: |
+      docker run \
+        -e BLOB_PROXY_PREFIX \
+        -e BLOB_STORAGE_PREFIX \
+        -e BLOB_STORAGE_IS_PUBLIC \
+        -e BLOB_DOWNLOAD_COMMAND \
+        -e BLOB_STORAGE_NAME \
+        -e BLOB_STORAGE_KEY \
+        -e GITHUB_COMMENT_AUTHOR_NAME \
+        -e GITHUBAPP_ID \
+        -e GITHUBAPP_PRIVATE_KEY \
+        -e NODE_OPTIONS \
+        -e SPEC_REPO \
+        -e PR_NUMBER \
+        -e SDK_REPO_NAME \
+        -e AZURE_DEVOPS_EXT_PAT \
+        -e BUILD_ID \
+        sdk-automation:latest npm start
+    condition: or(ne(variables['SDK_REPO_NAME'], 'azure-resource-manager-schemas'), endsWith(variables['SPEC_REPO'], '/azure-rest-api-specs'))
+    env:
+      BLOB_STORAGE_NAME: $(blob-storage-name)
+      BLOB_STORAGE_KEY: $(blob-storage-key)
+      BLOB_STORAGE_PREFIX: $(blob-storage-prefix)
+      BLOB_PROXY_PREFIX: $(blob-proxy-prefix)
+      BLOB_STORAGE_IS_PUBLIC: $(blob-is-public)
+      BLOB_DOWNLOAD_COMMAND: $(blob-download-command)
+      GITHUB_COMMENT_AUTHOR_NAME: $(github-comment-author-name)
+      GITHUBAPP_ID: $(githubapp-id)
+      GITHUBAPP_PRIVATE_KEY: $(githubapp-private-key)
+      AZURE_DEVOPS_EXT_PAT: $(azure-devops-ext-pat)
+    displayName: SDK Automation

.azure-pipelines/Spellcheck.yml

@@ -0,0 +1,14 @@
+jobs:
+- job: "Spellcheck"
+  variables:
+    NODE_OPTIONS: '--max-old-space-size=8192'
+  pool:
+    vmImage: 'Ubuntu 16.04'
+  continueOnError: true
+  steps:
+  - task: Npm@1
+    displayName: 'npm install'
+    inputs:
+      verbose: false
+  - script: 'npm run spellcheck'
+    displayName: 'Run cSpell'

.azure-pipelines/SwaggerToSDK.yml

@@ -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"

.azure-pipelines/Syntax.yml

@@ -0,0 +1,20 @@
+jobs:
+- job: "Syntax"
+  pool:
+    vmImage: 'Ubuntu 16.04'
+  steps:
+  - script: |
+      echo TRAVIS: $(TRAVIS)
+      echo TRAVIS_BRANCH: $(TRAVIS_BRANCH)
+      echo TRAVIS_REPO_SLUG: $(TRAVIS_REPO_SLUG)
+      echo TRAVIS_PULL_REQUEST: $(TRAVIS_PULL_REQUEST)
+      echo TRAVIS_PULL_REQUEST_SLUG: $(TRAVIS_PULL_REQUEST_SLUG)
+      echo TRAVIS_PULL_REQUEST_SHA: $(TRAVIS_PULL_REQUEST_SHA)
+      echo PR_ONLY: $(PR_ONLY)
+    displayName: "Info"
+  - task: Npm@1
+    displayName: 'npm install'
+    inputs:
+      verbose: false
+  - script: 'npm test -- test/syntax.js'
+    displayName: 'Syntax validation'

.azure-pipelines/azure-pipelines-data-container.yml

@@ -0,0 +1,41 @@
+schedules:
+- cron: "0 0 * * *"
+  displayName: Daily build
+  branches:
+    include:
+    - master
+  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

.github/CONTRIBUTING.md

@@ -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.)
 

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,17 +1,54 @@
-### 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
+Please ensure to add changelog with 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 you are targeting to deploy new service/feature to public regions? Please provide date, or month to public if date is not available yet.
+  3. When you expect to publish swagger? Please provide date, or month to public if date is not available yet.
+  4. If it's an update to existing version,  please select SDKs of specific language and CLIs that require refresh after 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, no need to refresh 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.
+- [ ] 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
-- [ ] 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).
+- [ ] Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.
+  - Adding new API(s)
+  - Adding a new API version
+  -  [ ] Ensure to copy the existing version into new directory structure for first commit (including refactoring) and then push new changes including version updates in separate commits. This is required to review the changes efficiently.
+  - Adding a new service
+
+- [ ] Please 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 there are following updates in the PR, ensure to request an approval from Breaking Change Review Board as defined in the [Breaking Change Policy](http://aka.ms/bcforapi). 
+
+- [ ] Removing API(s) in stable version
+- [ ] Removing properties in stable version
+- [ ] Removing API version(s) in stable version
+- [ ] Updating API in 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).