Adding list library and custom library referred schema changed (#12667)

navneet35 · Navneet Singh · web-flow · commit eb03a1281b64 · 2021-02-08T14:00:28.000+08:00
* List Libraries in Workspace API specs

* LibraryArtifacts changed to Libraries

* create and append library api separated using x-ms-paths to resolve SDK issue

* supressing R4009 systemData violation

Co-authored-by: Navneet Singh &lt;navsi@microsoft.com&gt;
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Library_Append.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Library_Append.json
@@ -0,0 +1,20 @@
+{
+  "parameters": {
+    "endpoint": "exampleWorkspace.dev.azuresynapse.net",
+    "libraryName": "exampleLibraryName.jar",
+    "api-version": "2019-06-01-preview",
+    "content": "file binary chunk",
+    "x-ms-blob-condition-appendpos": 12324
+  },
+  "responses": {
+    "201": {
+      "headers": {
+        "Date": "Fri, 23 Oct 2020 08:28:16 GMT",
+        "X-Content-Type-Options": "nosniff",
+        "x-ms-ratelimit-remaining-subscription-writes": "1192",
+        "x-ms-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264",
+        "x-ms-correlation-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264"
+      }
+    }
+  }
+}
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Library_Create.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Library_Create.json
@@ -2,21 +2,10 @@
   "parameters": {
     "endpoint": "exampleWorkspace.dev.azuresynapse.net",
     "libraryName": "exampleLibraryName.jar",
-    "api-version": "2019-06-01-preview",
-    "comp": "appendblock",
-    "content": "file binary chunk"
+    "api-version": "2019-06-01-preview"
   },
   "responses": {
     "200": {},
-    "201": {
-      "headers": {
-        "Date": "Fri, 23 Oct 2020 08:28:16 GMT",
-        "X-Content-Type-Options": "nosniff",
-        "x-ms-ratelimit-remaining-subscription-writes": "1192",
-        "x-ms-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264",
-        "x-ms-correlation-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264"
-      }
-    },
     "202": {
       "headers": {
         "Date": "Fri, 23 Oct 2020 08:28:16 GMT",
@@ -26,7 +15,7 @@
         "x-ms-correlation-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264"
       },
       "body": {
-        "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/libraryartifacts/exampleLibraryName.jar",
+        "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/libraries/exampleLibraryName.jar",
         "recordId": 1234,
         "state": "Creating",
         "created": "2020-10-23T07:59:29.1573546+00:00",
@@ -36,7 +25,6 @@
         "operationId": "1500474f-0000-0200-0000-5cbe090d0000",
         "artifactId": "2222222e-222d-222f-2222-22a2f222d2f2"
       }
-    },
-    "412": {}
+    }
   }
 }
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Library_Delete.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Library_Delete.json
@@ -15,7 +15,7 @@
         "x-ms-correlation-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264"
       },
       "body": {
-        "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/libraryartifacts/exampleLibraryName.jar",
+        "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/libraries/exampleLibraryName.jar",
         "recordId": 1234,
         "state": "Creating",
         "created": "2020-10-23T07:59:29.1573546+00:00",
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Library_Flush.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Library_Flush.json
@@ -15,7 +15,7 @@
         "x-ms-correlation-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264"
       },
       "body": {
-        "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/libraryartifacts/exampleLibraryName.jar",
+        "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/libraries/exampleLibraryName.jar",
         "recordId": 1234,
         "state": "Creating",
         "created": "2020-10-23T07:59:29.1573546+00:00",
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Library_Get.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Library_Get.json
@@ -16,9 +16,9 @@
         "x-ms-correlation-request-id": "99e5d0d9-55e6-45a0-8bd2-cf39210f317c"
       },
       "body": {
-        "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/libraryartifacts/exampleLibraryName.jar",
+        "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/libraries/exampleLibraryName.jar",
         "name": "exampleLibraryName.jar",
-        "type": "Microsoft.Synapse/workspaces/libraryartifacts",
+        "type": "Microsoft.Synapse/workspaces/libraries",
         "properties": {
           "name": "exampleLibraryName.jar",
           "path": "exampleWorkspace/libraries/exampleLibraryName.jar",
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Library_GetOperationResult.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Library_GetOperationResult.json
@@ -14,9 +14,9 @@
         "x-ms-correlation-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264"
       },
       "body": {
-        "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/libraryartifacts/exampleLibraryName.jar",
+        "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/libraries/exampleLibraryName.jar",
         "name": "exampleLibraryName.jar",
-        "type": "Microsoft.Synapse/workspaces/libraryartifacts",
+        "type": "Microsoft.Synapse/workspaces/libraries",
         "properties": {
           "name": "exampleLibraryName.jar",
           "path": "exampleWorkspace/libraries/exampleLibraryName.jar",
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Library_ListByWorkspace.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Library_ListByWorkspace.json
@@ -15,9 +15,9 @@
       "body": {
         "value": [
           {
-            "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/libraryartifacts/exampleLibraryName.jar",
+            "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/libraries/exampleLibraryName.jar",
             "name": "exampleLibraryName.jar",
-            "type": "Microsoft.Synapse/workspaces/libraryartifacts",
+            "type": "Microsoft.Synapse/workspaces/libraries",
             "properties": {
               "name": "exampleLibraryName.jar",
               "path": "exampleWorkspace/libraries/exampleLibraryName.jar",
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/library.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/library.json
@@ -224,14 +224,55 @@
         "tags": [
           "Library"
         ],
-        "operationId": "Library_CreateOrAppend",
+        "operationId": "Library_Create",
         "x-ms-examples": {
           "Create Library": {
-            "$ref": "./examples/Library_CreateOrAppend.json"
+            "$ref": "./examples/Library_Create.json"
           }
         },
-        "description": "Creates a library with the library name. Use query param 'comp=appendblock' to append the data to the library resource created using the create operation.",
+        "description": "Creates a library with the library name.",
         "x-ms-long-running-operation": true,
+        "parameters": [
+          {
+            "$ref": "#/parameters/ApiVersionParameter"
+          },
+          {
+            "$ref": "#/parameters/LibraryNameParameter"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Ok."
+          },
+          "202": {
+            "description": "In case of create operation, library resource information will be returned.",
+            "schema": {
+              "$ref": "#/definitions/LibraryResourceInfo"
+            }
+          },
+          "default": {
+            "description": "An error response received from the Azure Synapse service.",
+            "schema": {
+              "$ref": "#/definitions/CloudError"
+            }
+          }
+        }
+      }
+    }
+  },
+  "x-ms-paths": {
+    "/libraries/{libraryName}?comp=appendblock": {
+      "put": {
+        "tags": [
+          "Library"
+        ],
+        "operationId": "Library_Append",
+        "x-ms-examples": {
+          "Append Library": {
+            "$ref": "./examples/Library_Append.json"
+          }
+        },
+        "description": "Append the content to the library resource created using the create operation. The maximum content size is 4MiB. Content larger than 4MiB must be appended in 4MiB chunks",
         "consumes": [
           "application/octet-stream"
         ],
@@ -242,14 +283,11 @@
           {
             "$ref": "#/parameters/LibraryNameParameter"
           },
-          {
-            "$ref": "#/parameters/Component"
-          },
           {
             "name": "content",
             "in": "body",
-            "description": "Library file chunk. Use this content in with append operation.",
-            "required": false,
+            "description": "Library file chunk.",
+            "required": true,
             "schema": {
               "format": "binary",
               "type": "string"
@@ -259,26 +297,14 @@
             "name": "x-ms-blob-condition-appendpos",
             "in": "header",
             "description": "Set this header to a byte offset at which the block is expected to be appended. The request succeeds only if the current offset matches this value. Otherwise, the request fails with the AppendPositionConditionNotMet error (HTTP status code 412 – Precondition Failed)",
-            "required": false,
+            "required": true,
             "type": "integer",
             "format": "int64"
           }
         ],
         "responses": {
-          "200": {
-            "description": "Ok."
-          },
           "201": {
-            "description": "This will be returned in case of append operation."
-          },
-          "202": {
-            "description": "In case of create operation, library resource information will be returned.",
-            "schema": {
-              "$ref": "#/definitions/LibraryResourceInfo"
-            }
-          },
-          "412": {
-            "description": "This will happen in case the offset value provided in x-ms-blob-condition-appendpos doesn't match with the current offset value."
+            "description": "Created."
           },
           "default": {
             "description": "An error response received from the Azure Synapse service.",
@@ -515,14 +541,6 @@
       "type": "string",
       "description": "The Synapse client API Version."
     },
-    "Component": {
-      "name": "comp",
-      "in": "query",
-      "required": false,
-      "type": "string",
-      "description": "If this param is specified with value appendblock, the api will append the data chunk provided in body to the library created.",
-      "x-ms-parameter-location": "method"
-    },
     "Endpoint": {
       "name": "endpoint",
       "description": "The workspace development endpoint, for example https://myworkspace.dev.azuresynapse.net.",
diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2020-12-01/examples/Libraries_ListByWorkspace.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2020-12-01/examples/Libraries_ListByWorkspace.json
@@ -0,0 +1,55 @@
+{
+  "parameters": {
+    "subscriptionId": "12345678-1234-1234-1234-12345678abc",
+    "resourceGroupName": "exampleResourceGroup",
+    "workspaceName": "exampleWorkspace",
+    "ifNoneMatch": null,
+    "api-version": "2020-12-01"
+  },
+  "responses": {
+    "200": {
+      "headers": {
+        "Date": "Wed, 23 Oct 2020 21:33:05 GMT",
+        "X-Content-Type-Options": "nosniff",
+        "x-ms-ratelimit-remaining-subscription-reads": "14909",
+        "x-ms-request-id": "f632df92-1140-4e19-9e19-0b1c8cbe393b",
+        "x-ms-correlation-request-id": "f632df92-1140-4e19-9e19-0b1c8cbe393b"
+      },
+      "body": {
+        "value": [
+          {
+            "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspace/libraries/exampleLibraryName1.jar",
+            "name": "exampleLibraryName1.jar",
+            "type": "Microsoft.Synapse/workspaces/libraries",
+            "properties": {
+              "name": "exampleLibraryName1.jar",
+              "path": "exampleWorkspace/libraries/exampleLibraryName1.jar",
+              "containerName": "exampleContainer",
+              "type": "jar",
+              "uploadedTimestamp": "2020-10-23T07:59:29.1573546+00:00",
+              "provisioningStatus": "Succeeded",
+              "creatorId": "2222222e-222d-222f-2222-22a2f222d2f2"
+            },
+            "etag": "1500474f-0000-0200-0000-5cbe090d0000"
+          },
+          {
+            "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspace/libraries/exampleLibraryName2.jar",
+            "name": "exampleLibraryName2.jar",
+            "type": "Microsoft.Synapse/workspaces/libraries",
+            "properties": {
+              "name": "exampleLibraryName2.jar",
+              "path": "exampleWorkspace/libraries/exampleLibraryName2.jar",
+              "containerName": "exampleContainer",
+              "type": "jar",
+              "uploadedTimestamp": "2020-10-23T07:59:29.1573546+00:00",
+              "provisioningStatus": "Succeeded",
+              "creatorId": "2222222e-222d-222f-2222-22a2f222d2f2"
+            },
+            "etag": "1500474f-0000-0200-0000-5cbe090d0000"
+          }
+        ],
+        "nextLink": ""
+      }
+    }
+  }
+}
diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2020-12-01/examples/Library_Get.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2020-12-01/examples/Library_Get.json
@@ -0,0 +1,36 @@
+{
+  "parameters": {
+    "subscriptionId": "12345678-1234-1234-1234-12345678abc",
+    "resourceGroupName": "exampleResourceGroup",
+    "workspaceName": "exampleWorkspace",
+    "ifNoneMatch": null,
+    "libraryName": "exampleLibraryName.jar",
+    "api-version": "2020-12-01"
+  },
+  "responses": {
+    "200": {
+      "headers": {
+        "Date": "Wed, 23 Oct 2020 21:33:05 GMT",
+        "X-Content-Type-Options": "nosniff",
+        "x-ms-ratelimit-remaining-subscription-reads": "14909",
+        "x-ms-request-id": "f632df92-1140-4e19-9e19-0b1c8cbe393b",
+        "x-ms-correlation-request-id": "f632df92-1140-4e19-9e19-0b1c8cbe393b"
+      },
+      "body": {
+        "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspace/libraries/exampleLibraryName.jar",
+        "name": "exampleLibraryName.jar",
+        "type": "Microsoft.Synapse/workspaces/libraries",
+        "properties": {
+          "name": "exampleLibraryName.jar",
+          "path": "exampleWorkspace/libraries/exampleLibraryName.jar",
+          "containerName": "exampleContainer",
+          "type": "jar",
+          "uploadedTimestamp": "2020-10-23T07:59:29.1573546+00:00",
+          "provisioningStatus": "Succeeded",
+          "creatorId": "2222222e-222d-222f-2222-22a2f222d2f2"
+        },
+        "etag": "1500474f-0000-0200-0000-5cbe090d0000"
+      }
+    }
+  }
+}
diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2020-12-01/library.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2020-12-01/library.json
diff --git a/specification/synapse/resource-manager/readme.azureresourceschema.md b/specification/synapse/resource-manager/readme.azureresourceschema.md
diff --git a/specification/synapse/resource-manager/readme.md b/specification/synapse/resource-manager/readme.md
