Skip to content

Updated Swagger as per latest changes. #8427

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

Merged
yungezz merged 25 commits into from
Apr 7, 2020
Merged

Updated Swagger as per latest changes. #8427

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
ceb6e22
Updated Swagger as per latest changes.
Feb 18, 2020
2503391
Added description field
amoghnatu Feb 18, 2020
8e6467e
added readonly attribute
amoghnatu Feb 19, 2020
8f9ddf8
Fixed review comments
amoghnatu Feb 19, 2020
8277de2
Fixed model validation errors
amoghnatu Feb 20, 2020
f3ec322
fixed typo
amoghnatu Feb 20, 2020
2cff5d6
updated datetime format
amoghnatu Feb 20, 2020
c87389c
fixed error response definition path
amoghnatu Feb 20, 2020
2ffb27c
fixed prettier issues
amoghnatu Feb 20, 2020
ed1bd6e
updated readonly on the properties
amoghnatu Feb 20, 2020
f29e645
Changed enableFedRamp value
amoghnatu Feb 20, 2020
c86abe9
Renamed property
amoghnatu Feb 20, 2020
8bb00d5
removed unnecesary 404 code
amoghnatu Feb 21, 2020
5e294b3
removed 404 response in example
amoghnatu Feb 22, 2020
e06680c
removed 404
amoghnatu Feb 26, 2020
c4f724c
updated autorest
amoghnatu Feb 26, 2020
6975f8b
merged latest master
amoghnatu Mar 4, 2020
6c6f1c4
updated package version
amoghnatu Mar 4, 2020
bcff846
Reverted package.json and package lock json changes
amoghnatu Mar 5, 2020
f962ca3
added workspaceId and workspaceUrl properties to existing API version.
amoghnatu Mar 6, 2020
a7ea409
Added readonly to new properties.
amoghnatu Mar 6, 2020
55459a6
Reverted change in package.lock.json
amoghnatu Mar 10, 2020
41d5aec
Added missing 200 response on delete.
amoghnatu Mar 12, 2020
d7f4879
fixed model validation error.
amoghnatu Mar 12, 2020
f953e95
Removed FedRAMP parameter from api-version
amoghnatu Mar 16, 2020
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
9 changes: 9 additions & 0 deletions ...cation/databricks/resource-manager/Microsoft.Databricks/stable/2018-04-01/databricks.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -410,6 +410,14 @@
"createdDateTime": {
"description": "Specifies the date and time when the workspace is created.",
"$ref": "#/definitions/CreatedDateTime"
},
"workspaceId": {

@yungezz yungezz Mar 6, 2020

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

adding properties to existing version is breaking change. need to do it in new version

@amoghnatu amoghnatu Mar 6, 2020

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@yungezz We're going to backfill all existing databricks workspaces with these 2 properties. Any new workspaces created with this api-version will get these 2 properties by default. And all existing workspaces, we're going to backfill them next week. So this shouldn't technically remain as a breaking change after the backfilling is done. Also, since the backfill process is scheduled for next week, we request you to put a "DoNotMerge" label until we complete the process.

@yungezz yungezz Mar 6, 2020

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

HI @amoghnatu, thanks for sharing this. Adding new properties in response will break the GET-PUT pipeline, here's guideline of breaking change https://github.com/Azure/adx-documentation-pr/wiki/Breaking-changes-guidelines#new-property-added-to-response

@amoghnatu amoghnatu Mar 6, 2020

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@yungezz Thanks for mentioning this. However, in our case, these 2 new properties are readonly and the customer will not be able to set them. Also, these are not available in the template so user cannot set them to provide as input. I have updated the spec to include readonly=true for these 2 properties. Kindly check.

"description": "The unique identifier of the databricks workspace in databricks control plane.",
"type": "string"
},
"workspaceUrl": {
"description": "The workspace URL which is of the format 'adb-{workspaceId}.{random}.azuredatabricks.net'",
"type": "string"
}
},
"required": [
Expand Down Expand Up @@ -631,6 +639,7 @@
"CreatedDateTime": {
"type": "string",
"format": "date-time",
"description": "The date and time stamp when the workspace was created.",
"readOnly": true
},
"CreatedBy": {
Expand Down
4 changes: 3 additions & 1 deletion ...cks/resource-manager/Microsoft.Databricks/stable/2018-04-01/examples/WorkspaceCreate.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,9 @@
"puid": "33333333",
"applicationId": "44444444-4444-4444-4444-444444444444"
},
"createdDateTime": "2020-02-20T00:10:29.2858439Z"
"createdDateTime": "2020-02-20T00:10:29.2858439Z",
"workspaceId": "5555555555555555",
"workspaceUrl": "adb-5555555555555555.19.azuredatabricks.net"
}
}
},
Expand Down
4 changes: 3 additions & 1 deletion ...anager/Microsoft.Databricks/stable/2018-04-01/examples/WorkspaceCreateWithParameters.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,9 @@
"puid": "33333333",
"applicationId": "44444444-4444-4444-4444-444444444444"
},
"createdDateTime": "2020-02-20T00:10:29.2858439Z"
"createdDateTime": "2020-02-20T00:10:29.2858439Z",
"workspaceId": "5555555555555555",
"workspaceUrl": "adb-5555555555555555.19.azuredatabricks.net"
}
}
},
Expand Down
4 changes: 3 additions & 1 deletion ...bricks/resource-manager/Microsoft.Databricks/stable/2018-04-01/examples/WorkspaceGet.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,9 @@
"puid": "33333333",
"applicationId": "44444444-4444-4444-4444-444444444444"
},
"createdDateTime": "2020-02-20T00:10:29.2858439Z"
"createdDateTime": "2020-02-20T00:10:29.2858439Z",
"workspaceId": "5555555555555555",
"workspaceUrl": "adb-5555555555555555.19.azuredatabricks.net"
}
}
}
Expand Down
4 changes: 3 additions & 1 deletion ...ource-manager/Microsoft.Databricks/stable/2018-04-01/examples/WorkspaceGetParameters.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,9 @@
"puid": "33333333",
"applicationId": "44444444-4444-4444-4444-444444444444"
},
"createdDateTime": "2020-02-20T00:10:29.2858439Z"
"createdDateTime": "2020-02-20T00:10:29.2858439Z",
"workspaceId": "5555555555555555",
"workspaceUrl": "adb-5555555555555555.19.azuredatabricks.net"
}
}
}
Expand Down
4 changes: 3 additions & 1 deletion ...cks/resource-manager/Microsoft.Databricks/stable/2018-04-01/examples/WorkspaceUpdate.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,9 @@
"puid": "33333333",
"applicationId": "44444444-4444-4444-4444-444444444444"
},
"createdDateTime": "2020-02-20T00:10:29.2858439Z"
"createdDateTime": "2020-02-20T00:10:29.2858439Z",
"workspaceId": "6666666666666666",
"workspaceUrl": "adb-6666666666666666.19.azuredatabricks.net"
}
}
},
Expand Down
8 changes: 6 additions & 2 deletions ...anager/Microsoft.Databricks/stable/2018-04-01/examples/WorkspacesListByResourceGroup.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,9 @@
"puid": "33333333",
"applicationId": "44444444-4444-4444-4444-444444444444"
},
"createdDateTime": "2020-02-20T00:10:29.2858439Z"
"createdDateTime": "2020-02-20T00:10:29.2858439Z",
"workspaceId": "5555555555555555",
"workspaceUrl": "adb-5555555555555555.19.azuredatabricks.net"
}
},
{
Expand Down Expand Up @@ -72,7 +74,9 @@
"puid": "33333333",
"applicationId": "44444444-4444-4444-4444-444444444444"
},
"createdDateTime": "2020-02-20T00:10:29.2858439Z"
"createdDateTime": "2020-02-20T00:10:29.2858439Z",
"workspaceId": "6666666666666666",
"workspaceUrl": "adb-6666666666666666.19.azuredatabricks.net"
}
}
]
Expand Down
8 changes: 6 additions & 2 deletions ...manager/Microsoft.Databricks/stable/2018-04-01/examples/WorkspacesListBySubscription.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,9 @@
"puid": "33333333",
"applicationId": "44444444-4444-4444-4444-444444444444"
},
"createdDateTime": "2020-02-20T00:10:29.2858439Z"
"createdDateTime": "2020-02-20T00:10:29.2858439Z",
"workspaceId": "5555555555555555",
"workspaceUrl": "adb-5555555555555555.19.azuredatabricks.net"
}
},
{
Expand Down Expand Up @@ -71,7 +73,9 @@
"puid": "33333333",
"applicationId": "44444444-4444-4444-4444-444444444444"
},
"createdDateTime": "2020-02-20T00:10:29.2858439Z"
"createdDateTime": "2020-02-20T00:10:29.2858439Z",
"workspaceId": "6666666666666666",
"workspaceUrl": "adb-6666666666666666.19.azuredatabricks.net"
}
}
]
Expand Down