Fix Swagger correctness bugs. (#16280)

samuelkuangms · web-flow · commit cbce56cd44b0 · 2021-10-15T16:27:13.000+08:00
diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/SourceControls.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/SourceControls.json
@@ -360,14 +360,20 @@
           "description": "source control properties",
           "$ref": "#/definitions/SourceControlProperties",
           "x-ms-client-flatten": true
+        },
+        "systemData": {
+          "description": "System data of Cluster resource",
+          "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData",
+          "x-ms-client-flatten": true,
+          "readOnly": true
         }
       },
       "type": "object"
     },
     "SourceControlProperties": {
       "description": "Describes source control properties",
       "properties": {
-        "sourceControlId": {
+        "id": {
           "description": "The id (a Guid) of the source control",
           "type": "string"
         },
@@ -416,6 +422,14 @@
           "description": "Branch name of repository.",
           "type": "string"
         },
+        "displayUrl": {
+          "description": "Display url of repository.",
+          "type": "string"
+        },
+        "deploymentLogsUrl": {
+          "description": "Url to access repository action logs.",
+          "type": "string"
+        },
         "pathMapping": {
           "description": "Dictionary of source control content type and path mapping.",
           "items": {
diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/sourcecontrols/CreateSourceControl.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/sourcecontrols/CreateSourceControl.json
@@ -19,6 +19,7 @@
         "repository": {
           "url": "https://github.com/user/repo",
           "branch": "master",
+          "displayUrl": "https://github.com/user/repo",
           "pathMapping": [
             {
               "contentType": "AnalyticRules",
@@ -41,7 +42,7 @@
         "type": "Microsoft.SecurityInsights/SourceControls",
         "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"",
         "properties": {
-          "sourceControlId": "789e0c1f-4a3d-43ad-809c-e713b677b04a",
+          "id": "789e0c1f-4a3d-43ad-809c-e713b677b04a",
           "displayName": "My Source Control",
           "description": "this is a source control",
           "repoType": "Github",
@@ -52,6 +53,8 @@
           "repository": {
             "url": "https://github.com/user/repo",
             "branch": "master",
+            "displayUrl": "https://github.com/user/repo",
+            "deploymentLogsUrl": "https://github.com/user/repo/actions",
             "pathMapping": [
               {
                 "contentType": "AnalyticRules",
@@ -63,6 +66,14 @@
               }
             ]
           }
+        },
+        "systemData": {
+          "createdBy": "user1",
+          "createdByType": "User",
+          "createdAt": "2021-01-01T17:18:19.1234567Z",
+          "lastModifiedBy": "user2",
+          "lastModifiedByType": "User",
+          "lastModifiedAt": "2021-01-02T17:18:19.1234567Z"
         }
       }
     },
@@ -73,7 +84,7 @@
         "type": "Microsoft.SecurityInsights/SourceControls",
         "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"",
         "properties": {
-          "sourceControlId": "789e0c1f-4a3d-43ad-809c-e713b677b04a",
+          "id": "789e0c1f-4a3d-43ad-809c-e713b677b04a",
           "displayName": "My Source Control",
           "description": "this is a source control",
           "repoType": "Github",
@@ -84,6 +95,8 @@
           "repository": {
             "url": "https://github.com/user/repo",
             "branch": "master",
+            "displayUrl": "https://github.com/user/repo",
+            "deploymentLogsUrl": "https://github.com/user/repo/actions",
             "pathMapping": [
               {
                 "contentType": "AnalyticRules",
@@ -95,6 +108,14 @@
               }
             ]
           }
+        },
+        "systemData": {
+          "createdBy": "user1",
+          "createdByType": "User",
+          "createdAt": "2021-01-01T17:18:19.1234567Z",
+          "lastModifiedBy": "user2",
+          "lastModifiedByType": "User",
+          "lastModifiedAt": "2021-01-02T17:18:19.1234567Z"
         }
       }
     }
diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/sourcecontrols/GetSourceControlById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/sourcecontrols/GetSourceControlById.json
@@ -15,7 +15,7 @@
         "type": "Microsoft.SecurityInsights/SourceControls",
         "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"",
         "properties": {
-          "sourceControlId": "789e0c1f-4a3d-43ad-809c-e713b677b04a",
+          "id": "789e0c1f-4a3d-43ad-809c-e713b677b04a",
           "displayName": "My Source Control",
           "description": "this is a source control",
           "repoType": "Github",
@@ -26,6 +26,8 @@
           "repository": {
             "url": "https://github.com/user/repo",
             "branch": "master",
+            "displayUrl": "https://github.com/user/repo",
+            "deploymentLogsUrl": "https://github.com/user/repo/actions",
             "pathMapping": [
               {
                 "contentType": "AnalyticRules",
@@ -37,6 +39,14 @@
               }
             ]
           }
+        },
+        "systemData": {
+          "createdBy": "user1",
+          "createdByType": "User",
+          "createdAt": "2021-01-01T17:18:19.1234567Z",
+          "lastModifiedBy": "user2",
+          "lastModifiedByType": "User",
+          "lastModifiedAt": "2021-01-02T17:18:19.1234567Z"
         }
       }
     }
diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/sourcecontrols/GetSourceControls.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/sourcecontrols/GetSourceControls.json
@@ -16,7 +16,7 @@
             "type": "Microsoft.SecurityInsights/SourceControls",
             "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"",
             "properties": {
-              "sourceControlId": "789e0c1f-4a3d-43ad-809c-e713b677b04a",
+              "id": "789e0c1f-4a3d-43ad-809c-e713b677b04a",
               "displayName": "My Source Control",
               "description": "this is a source control",
               "repoType": "Github",
@@ -27,6 +27,8 @@
               "repository": {
                 "url": "https://github.com/user/repo",
                 "branch": "master",
+                "displayUrl": "https://github.com/user/repo",
+                "deploymentLogsUrl": "https://github.com/user/repo/actions",
                 "pathMapping": [
                   {
                     "contentType": "AnalyticRules",
@@ -38,6 +40,14 @@
                   }
                 ]
               }
+            },
+            "systemData": {
+              "createdBy": "user1",
+              "createdByType": "User",
+              "createdAt": "2021-01-01T17:18:19.1234567Z",
+              "lastModifiedBy": "user2",
+              "lastModifiedByType": "User",
+              "lastModifiedAt": "2021-01-02T17:18:19.1234567Z"
             }
           }
         ]

Original file line number	Diff line number	Diff line change
`@@ -19,6 +19,7 @@`
`19`	`19`	`"repository": {`
`20`	`20`	`"url": "https://github.com/user/repo",`
`21`	`21`	`"branch": "master",`
	`22`	`+ "displayUrl": "https://github.com/user/repo",`
`22`	`23`	`"pathMapping": [`
`23`	`24`	`{`
`24`	`25`	`"contentType": "AnalyticRules",`
`@@ -41,7 +42,7 @@`
`41`	`42`	`"type": "Microsoft.SecurityInsights/SourceControls",`
`42`	`43`	`"etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"",`
`43`	`44`	`"properties": {`
`44`		`- "sourceControlId": "789e0c1f-4a3d-43ad-809c-e713b677b04a",`
	`45`	`+ "id": "789e0c1f-4a3d-43ad-809c-e713b677b04a",`
`45`	`46`	`"displayName": "My Source Control",`
`46`	`47`	`"description": "this is a source control",`
`47`	`48`	`"repoType": "Github",`
`@@ -52,6 +53,8 @@`
`52`	`53`	`"repository": {`
`53`	`54`	`"url": "https://github.com/user/repo",`
`54`	`55`	`"branch": "master",`
	`56`	`+ "displayUrl": "https://github.com/user/repo",`
	`57`	`+ "deploymentLogsUrl": "https://github.com/user/repo/actions",`
`55`	`58`	`"pathMapping": [`
`56`	`59`	`{`
`57`	`60`	`"contentType": "AnalyticRules",`
`@@ -63,6 +66,14 @@`
`63`	`66`	`}`
`64`	`67`	`]`
`65`	`68`	`}`
	`69`	`+ },`
	`70`	`+ "systemData": {`
	`71`	`+ "createdBy": "user1",`
	`72`	`+ "createdByType": "User",`
	`73`	`+ "createdAt": "2021-01-01T17:18:19.1234567Z",`
	`74`	`+ "lastModifiedBy": "user2",`
	`75`	`+ "lastModifiedByType": "User",`
	`76`	`+ "lastModifiedAt": "2021-01-02T17:18:19.1234567Z"`
`66`	`77`	`}`
`67`	`78`	`}`
`68`	`79`	`},`
`@@ -73,7 +84,7 @@`
`73`	`84`	`"type": "Microsoft.SecurityInsights/SourceControls",`
`74`	`85`	`"etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"",`
`75`	`86`	`"properties": {`
`76`		`- "sourceControlId": "789e0c1f-4a3d-43ad-809c-e713b677b04a",`
	`87`	`+ "id": "789e0c1f-4a3d-43ad-809c-e713b677b04a",`
`77`	`88`	`"displayName": "My Source Control",`
`78`	`89`	`"description": "this is a source control",`
`79`	`90`	`"repoType": "Github",`
`@@ -84,6 +95,8 @@`
`84`	`95`	`"repository": {`
`85`	`96`	`"url": "https://github.com/user/repo",`
`86`	`97`	`"branch": "master",`
	`98`	`+ "displayUrl": "https://github.com/user/repo",`
	`99`	`+ "deploymentLogsUrl": "https://github.com/user/repo/actions",`
`87`	`100`	`"pathMapping": [`
`88`	`101`	`{`
`89`	`102`	`"contentType": "AnalyticRules",`
`@@ -95,6 +108,14 @@`
`95`	`108`	`}`
`96`	`109`	`]`
`97`	`110`	`}`
	`111`	`+ },`
	`112`	`+ "systemData": {`
	`113`	`+ "createdBy": "user1",`
	`114`	`+ "createdByType": "User",`
	`115`	`+ "createdAt": "2021-01-01T17:18:19.1234567Z",`
	`116`	`+ "lastModifiedBy": "user2",`
	`117`	`+ "lastModifiedByType": "User",`
	`118`	`+ "lastModifiedAt": "2021-01-02T17:18:19.1234567Z"`
`98`	`119`	`}`
`99`	`120`	`}`
`100`	`121`	`}`
Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@`
`15`	`15`	`"type": "Microsoft.SecurityInsights/SourceControls",`
`16`	`16`	`"etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"",`
`17`	`17`	`"properties": {`
`18`		`- "sourceControlId": "789e0c1f-4a3d-43ad-809c-e713b677b04a",`
	`18`	`+ "id": "789e0c1f-4a3d-43ad-809c-e713b677b04a",`
`19`	`19`	`"displayName": "My Source Control",`
`20`	`20`	`"description": "this is a source control",`
`21`	`21`	`"repoType": "Github",`
`@@ -26,6 +26,8 @@`
`26`	`26`	`"repository": {`
`27`	`27`	`"url": "https://github.com/user/repo",`
`28`	`28`	`"branch": "master",`
	`29`	`+ "displayUrl": "https://github.com/user/repo",`
	`30`	`+ "deploymentLogsUrl": "https://github.com/user/repo/actions",`
`29`	`31`	`"pathMapping": [`
`30`	`32`	`{`
`31`	`33`	`"contentType": "AnalyticRules",`
`@@ -37,6 +39,14 @@`
`37`	`39`	`}`
`38`	`40`	`]`
`39`	`41`	`}`
	`42`	`+ },`
	`43`	`+ "systemData": {`
	`44`	`+ "createdBy": "user1",`
	`45`	`+ "createdByType": "User",`
	`46`	`+ "createdAt": "2021-01-01T17:18:19.1234567Z",`
	`47`	`+ "lastModifiedBy": "user2",`
	`48`	`+ "lastModifiedByType": "User",`
	`49`	`+ "lastModifiedAt": "2021-01-02T17:18:19.1234567Z"`
`40`	`50`	`}`
`41`	`51`	`}`
`42`	`52`	`}`
Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@`
`16`	`16`	`"type": "Microsoft.SecurityInsights/SourceControls",`
`17`	`17`	`"etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"",`
`18`	`18`	`"properties": {`
`19`		`- "sourceControlId": "789e0c1f-4a3d-43ad-809c-e713b677b04a",`
	`19`	`+ "id": "789e0c1f-4a3d-43ad-809c-e713b677b04a",`
`20`	`20`	`"displayName": "My Source Control",`
`21`	`21`	`"description": "this is a source control",`
`22`	`22`	`"repoType": "Github",`
`@@ -27,6 +27,8 @@`
`27`	`27`	`"repository": {`
`28`	`28`	`"url": "https://github.com/user/repo",`
`29`	`29`	`"branch": "master",`
	`30`	`+ "displayUrl": "https://github.com/user/repo",`
	`31`	`+ "deploymentLogsUrl": "https://github.com/user/repo/actions",`
`30`	`32`	`"pathMapping": [`
`31`	`33`	`{`
`32`	`34`	`"contentType": "AnalyticRules",`
`@@ -38,6 +40,14 @@`
`38`	`40`	`}`
`39`	`41`	`]`
`40`	`42`	`}`
	`43`	`+ },`
	`44`	`+ "systemData": {`
	`45`	`+ "createdBy": "user1",`
	`46`	`+ "createdByType": "User",`
	`47`	`+ "createdAt": "2021-01-01T17:18:19.1234567Z",`
	`48`	`+ "lastModifiedBy": "user2",`
	`49`	`+ "lastModifiedByType": "User",`
	`50`	`+ "lastModifiedAt": "2021-01-02T17:18:19.1234567Z"`
`41`	`51`	`}`
`42`	`52`	`}`
`43`	`53`	`]`