Merge branch 'master' of https://github.com/Azure/azure-rest-api-specs into ANF-8208-UpdateSwaggerRestAPI-to-2020-09-01

Author: audunn

.github/comment.yml

@@ -23,3 +23,8 @@
     type: label
     label: Approved-OkToMerge
     onLabeledComments: "Hi @${PRAuthor},Your PR is approved. Congratulations. </br> <li> If your PR is in public repo (azure-rest-api-specs),  PR assignee will merge all updates in the PR shortly afterwards; or pause the PR merge, you need to put on a label <b>DoNotMerge</b> to PR as soon as possible. </li><li>If your PR is in private repo (azure-rest-api-specs-pr),  there won’t be PR merge.  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**) for further guidance on how to proceed. </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.  "

.github/pull_request_assignment.yml

@@ -136,33 +136,23 @@
 
 - rule:
     paths:
-      - "**/package.json"
-      - ".github/**"
-      - "**/azure-pipelines.yml"
-      - ".azure-pipelines/**"
-      - ".azure-pipelines-preproduction/**"
+      - "documentation/**"	
     reviewers:
+      - josefree
       - akning-ms
-      - PhoenixHe-msft
-      
-- rule:	
-    paths:	
-      - "documentation/**"	
-    reviewers:	
-      - josefree	
-      - akning-ms	
 
-- rule:	
-    paths:	
+- rule:
+    paths:
       - "**/package.json"	
       - ".github/**"	
       - "**/azure-pipelines.yml"	
       - ".azure-pipelines/**"	
       - ".azure-pipelines-preproduction/**"	
-    reviewers:	
-      - akning-ms	
-      - PhoenixHe-msft	
+    reviewers:
+      - akning-ms
+      - PhoenixHe-msft
       - raych1
+      - zhenglaizhang
 
 - rule:
     # manager-plane PR
@@ -185,3 +175,4 @@
       - qianwens
       - ruowan
       - jianyexi
+      - zhenglaizhang

cSpell.json

@@ -748,6 +748,14 @@
                 "pstn",
                 "unconfiguring"
             ]
+        },
+        {
+            "filename": "**/specification/saas/resource-manager/Microsoft.SaaS/preview/2018-03-01-beta/saas.json",
+            "words": [
+                "checkmoderneligibility",
+                "saasresources",
+                "Moderneligibility"
+            ]
         }
     ]
 }

custom-words.txt

@@ -35,6 +35,7 @@ adhybridhealthservice
 adla
 adls
 adminmanagement
+ADSIs
 ADTO
 adultscore
 affinitized
@@ -392,6 +393,7 @@ createpreview
 credativ
 Creds
 crossdomain
+cscfg
 csname
 CSRP
 csrs
@@ -496,8 +498,11 @@ deserializing
 destinationshares
 deterministically
 devicecredentials
+devicegroups
 deviceprovisioningservices
 devicetemplates
+Devops
+devops
 devspaces
 devtestlab
 devtestlabs
@@ -740,6 +745,7 @@ HCRP
 HDFS
 hdinsight
 Headnode
+healthbot
 healthcareapis
 Heatbeat
 heatmap
@@ -1509,6 +1515,7 @@ Scaleset
 scalesets
 Scame
 scanability
+ScheduleType
 SCMS
 SCOM
 scopemap
@@ -1601,6 +1608,7 @@ SMBIOS
 snapshotrun
 snapshotsdr
 SNAT
+SNMP
 softwareplan
 SOHSV
 solaris
@@ -1713,6 +1721,7 @@ supportedvpndevices
 supporttickets
 susbcriptionid
 svpn
+swappable
 swappiness
 Swappiness
 switchprotection
@@ -1862,7 +1871,6 @@ Unregistering
 Unregisters
 unrestorable
 unsubstituted
-Unsynced
 untagged
 Untracked
 unvalidated
@@ -2030,4 +2038,8 @@ Zilla
 ziplist
 Zoho
 zoneinfo
-zset
+zset
+tpgs
+ProviderHub
+checkin
+regionality

documentation/openapi-authoring-automated-guidelines.md

@@ -20,7 +20,7 @@ We request OpenAPI(Swagger) spec authoring be assigned to engineers who have an
 * [Rule Descriptions](#rule-descriptions)
 
 ## Error vs Warning
-- Rules with severity "Error" have to be addressed for the OpenAPI(swagger) spec to be approved by the reviewers. If there is a strong reason for why the rule cannot be addressed in an OpenAPI(swagger) spec it will be a permanent exception, then [suppression process](https://github.com/Azure/adx-documentation-pr/wiki/Swagger-Validation-Errors-Suppression) must be followed.
+- Rules with severity "Error" have to be addressed for the OpenAPI(swagger) spec to be approved by the reviewers. If there is a strong reason for why the rule cannot be addressed in an OpenAPI(swagger) spec it will be a permanent exception, then [suppression process](https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/85/Swagger-Suppression-Process) must be followed.
 
 - Rules with severity "Warning" are either strong recommendations made by Azure developer experience team for better SDK/Documentation experience or they point out something to evaluate, for example, the warning for booleans asks the user to evaluate whether the property should be a boolean or not. 
 
@@ -2349,35 +2349,55 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul
 **LastModifiedAt**: April 2, 2020
 
 **How to fix the violation**: Following the ARM specification to modify the schema in the swagger file.
+It's recommended to refer to the 'ErrorResponse' in [v2/types.json](https://github.com/Azure/azure-rest-api-specs/blob/master/specification/common-types/resource-management/v2/types.json#L273) which is provided for fixing the error.
 
 The following would be invalid:
 
 ```json
- "response":{
-   "default": {
-     "schema":{
-         "error":"error msg",
-         "code": 404,
-         "message":"some details"
+"definitions": {
+  "ErrorResponse": {
+     "properties": {
+       "code": {
+         "readOnly": true,
+         "type": "string",
+         "description": "The error code."
+       },
+       "message": {
+         "readOnly": true,
+         "type": "string",
+         "description": "The error message."
+       }
+       ...
      }
   }
- }
-
+}
 ```
 
 the correct schema:
 
 ```json
- "response":{
-   "default": {
-     "error":
-     {
-        "code": 404,
-        "message":"some details"
-         ...
+"definitions": {
+  "ErrorResponse": {
+     "properties": {
+        "error": {
+          "type": "object",
+          "description": "The error object.",
+          "properties": {
+            "code": {
+              "readOnly": true,
+              "type": "string",
+              "description": "The error code."
+            },
+            "message": {
+              "readOnly": true,
+              "type": "string",
+              "description": "The error message."
+            }
+            ...
+        }
      }
   }
- }
+}
 
 ```
 
@@ -2758,7 +2778,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul
 
 **Output Message** : The response schema of operations API "{0}" does not match the ARM specification. Please standardize the schema.
 
-**Description** : The operations API should have a response body schema consistent with the [contract spec](https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/proxy-api-reference.md#exposing-available-operations). The required properties such as `isDataAction`,`display.description` or `display.resource`,must be included.
+**Description** : The operations API should have a response body schema consistent with the [contract spec](https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/proxy-api-reference.md#exposing-available-operations). The required properties such as `isDataAction`,`display.description` and `display.resource`,must be included.
 
 **CreatedAt**: July 13, 2020
 

documentation/samplefiles/samplereadme.md

@@ -62,20 +62,20 @@ swagger-to-sdk:
 
 ## Go
 
-See configuration in [readme.go.md](https://github.com/Azure/azure-rest-api-specs/blob/master/documentation/samplefiles/readme.go.md)
+See configuration in [readme.go.md](./readme.go.md)
 
 ## Python
 
-See configuration in [readme.python.md](https://github.com/Azure/azure-rest-api-specs/blob/master/documentation/samplefiles/readme.python.md)
+See configuration in [readme.python.md](./readme.python.md)
 
 ## TypeScript
 
-See configuration in [readme.typescript.md](https://github.com/Azure/azure-rest-api-specs/blob/master/documentation/samplefiles/readme.typescript.md)
+See configuration in [readme.typescript.md](./readme.typescript.md)
 
 ## CSharp
 
-See configuration in [readme.csharp.md](https://github.com/Azure/azure-rest-api-specs/blob/master/documentation/samplefiles/readme.chsarp.md)
+See configuration in [readme.csharp.md](./readme.csharp.md)
 
 ## AzureResourceSchema
 
-See configuration in [readme.azureresourceschema.md](https://github.com/Azure/azure-rest-api-specs/blob/master/documentation/samplefiles/readme.azureresourceschema.md)
+See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md)

specification/advisor/resource-manager/Microsoft.Advisor/stable/2020-01-01/advisor.json

@@ -541,6 +541,12 @@
             "schema": {
               "$ref": "#/definitions/SuppressionContract"
             }
+          },
+          "404": {
+            "description": "Suppression name is not specified or Suppression Id not found.",
+            "schema": {
+              "$ref": "#/definitions/ARMErrorResponseBody"
+            }
           }
         },
         "deprecated": false,
@@ -1189,6 +1195,12 @@
         "ttl": {
           "description": "The duration for which the suppression is valid.",
           "type": "string"
+        },
+        "expirationTimeStamp": {
+          "readOnly": true,
+          "format": "date-time",
+          "description": "Gets or sets the expiration time stamp.",
+          "type": "string"
         }
       }
     },

specification/advisor/resource-manager/Microsoft.Advisor/stable/2020-01-01/examples/GetSuppressionDetail.json

@@ -13,9 +13,16 @@
         "type": "Microsoft.Advisor/suppressions",
         "properties": {
           "suppressionId": "suppressionId1",
-          "ttl": "7.00:00:00"
+          "ttl": "7.00:00:00",
+          "expirationTimeStamp": "2020-10-25T22:24:43.3216408Z"
         }
       }
+    },
+    "404": {
+      "body": {
+        "code": "NotFound",
+        "message": "Suppression name is not specified or Suppression Id not found"
+      }
     }
   }
 }

specification/advisor/resource-manager/Microsoft.Advisor/stable/2020-01-01/examples/ListSuppressions.json

@@ -14,7 +14,8 @@
             "type": "Microsoft.Advisor/suppressions",
             "properties": {
               "suppressionId": "suppressionId1",
-              "ttl": "7.00:00:00"
+              "ttl": "7.00:00:00",
+              "expirationTimeStamp": "2020-10-24T22:24:43.3216408Z"
             }
           },
           {
@@ -23,7 +24,8 @@
             "type": "Microsoft.Advisor/suppressions",
             "properties": {
               "suppressionId": "suppressionId2",
-              "ttl": "7.00:00:00"
+              "ttl": "7.00:00:00",
+              "expirationTimeStamp": "2020-10-25T22:24:43.3216408Z"
             }
           }
         ]