Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding list library and custom library referred schema changed #12667

Merged
merged 4 commits into from
Feb 8, 2021
Merged

Adding list library and custom library referred schema changed #12667

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
424b233
List Libraries in Workspace API specs
Jan 28, 2021
afd1a76
LibraryArtifacts changed to Libraries
Feb 2, 2021
1a9f3fb
create and append library api separated using x-ms-paths to resolve S…
Feb 3, 2021
7c54151
supressing R4009 systemData violation
Feb 4, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions ...apse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Library_Append.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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"
}
}
}
}
18 changes: 3 additions & 15 deletions ...view/examples/Library_CreateOrAppend.json → ...6-01-preview/examples/Library_Create.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand All @@ -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",
Expand All @@ -36,7 +25,6 @@
"operationId": "1500474f-0000-0200-0000-5cbe090d0000",
"artifactId": "2222222e-222d-222f-2222-22a2f222d2f2"
}
},
"412": {}
}
}
}
2 changes: 1 addition & 1 deletion ...apse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Library_Delete.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
2 changes: 1 addition & 1 deletion ...napse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Library_Flush.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
4 changes: 2 additions & 2 deletions ...synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Library_Get.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
4 changes: 2 additions & 2 deletions ...ane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Library_GetOperationResult.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
4 changes: 2 additions & 2 deletions ...-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Library_ListByWorkspace.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
78 changes: 48 additions & 30 deletions specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/library.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
navneet35 marked this conversation as resolved.
Show resolved Hide resolved
"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"
],
Expand All @@ -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"
Expand All @@ -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.",
Expand Down Expand Up @@ -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.",
Expand Down
55 changes: 55 additions & 0 deletions ...ource-manager/Microsoft.Synapse/stable/2020-12-01/examples/Libraries_ListByWorkspace.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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": ""
}
}
}
}
36 changes: 36 additions & 0 deletions ...on/synapse/resource-manager/Microsoft.Synapse/stable/2020-12-01/examples/Library_Get.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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"
}
}
}
}
Loading