Changes for Microsoft.DataMigration GA stable version 2018-04-19.#2936
Changes for Microsoft.DataMigration GA stable version 2018-04-19.#2936hovsepm merged 10 commits intoAzure:masterfrom binuj:master
Conversation
…review/2018-03-31-preview'. Next commit will have the actual changes for version 2018-04-19.
…s not scoped for GA.
Automation for azure-libraries-for-javaNothing to generate for azure-libraries-for-java |
Automation for azure-sdk-for-nodeNothing to generate for azure-sdk-for-node |
AutoRest linter results for ARM Related Validation Errors/WarningsThese errors are reported by the ARM team's validation tools, reachout to ARM RP API Review directly for any questions or concerns. File: specification/datamigration/resource-manager/readme.md
|
AutoRest linter results for SDK Related Validation Errors/WarningsThese errors are reported by the SDK team's validation tools, reachout to ADX Swagger Reviewers directly for any questions or concerns. File: specification/datamigration/resource-manager/readme.md
|
Automation for azure-sdk-for-pythonThe initial PR has been merged into your service PR: |
Automation for azure-sdk-for-goThe initial PR has been merged into your service PR: |
AutoRest linter results for ARM Related Validation Errors/WarningsThese errors are reported by the ARM team's validation tools, reachout to ARM RP API Review directly for any questions or concerns. File: specification/datamigration/resource-manager/readme.md
|
AutoRest linter results for SDK Related Validation Errors/WarningsThese errors are reported by the SDK team's validation tools, reachout to ADX Swagger Reviewers directly for any questions or concerns. File: specification/datamigration/resource-manager/readme.md
|
| - Microsoft.DataMigration/preview/2018-03-31-preview/definitions/MigrationValidation.json | ||
| - Microsoft.DataMigration/preview/2018-03-31-preview/definitions/ValidateMigrationInputSqlServerSqlMITask.json | ||
| ``` | ||
|
|
There was a problem hiding this comment.
Line 31 in readme.md has default as "tag: package-2018-03-31-preview".
Change this to the GA version. The public repo sdk picks up the version number from here.
AutoRest linter results for SDK Related Validation Errors/WarningsThese errors are reported by the SDK team's validation tools, reachout to ADX Swagger Reviewers directly for any questions or concerns. File: specification/datamigration/resource-manager/readme.md
|
AutoRest linter results for ARM Related Validation Errors/WarningsThese errors are reported by the ARM team's validation tools, reachout to ARM RP API Review directly for any questions or concerns. File: specification/datamigration/resource-manager/readme.md
|
| - Microsoft.DataMigration/preview/2018-03-31-preview/definitions/ValidateMigrationInputSqlServerSqlMITask.json | ||
| ``` | ||
|
|
||
| ### Tag: package-2018-04-19 |
There was a problem hiding this comment.
please reorganize readme.md to have most resent tag at the top.
| ], | ||
| "x-ms-enum": { | ||
| "name": "NameCheckFailureReason", | ||
| "modelAsString": true |
There was a problem hiding this comment.
"modelAsString": true [](start = 12, length = 21)
just a reminder - if enum is not modeled as string any time you will need to add a new enum member to it will be a breaking change and will require an API version bump. I'd strongly recommend marking enums as string
There was a problem hiding this comment.
Just confirming - There is no change needed right? The usage here follows the recommended way of defining enums, correct?
There was a problem hiding this comment.
Currently all the enums are marked as "modelAsString": true
There was a problem hiding this comment.
No changes asked for now, just a warning for a possible breaking change in the future.
There was a problem hiding this comment.
My comment rather came from already existing enums in Tasks.json (e.g. ProjectTaskProperties.State). Your PR has all the new enums marked as string types which is exactly what I was recommending :) sorry for the confusion.
| "description": "The current value of the quota. If null or missing, the current value cannot be determined in the context of the request." | ||
| }, | ||
| "id": { | ||
| "type": "string", |
There was a problem hiding this comment.
Isn't this field read-only? if so should be marked as "readOnly": true,
There was a problem hiding this comment.
In general any property of a type that is supposed to be sent only in one direction from Server to Client should be marked as "readOnly": true,
In reply to: 183830418 [](ancestors = 183830418)
|
@ravbhatnagar could you check if this was approved? |
| "type": "object", | ||
| "description": "Information about a single database", | ||
| "properties": { | ||
| "id": { |
There was a problem hiding this comment.
id [](start = 9, length = 2)
Readonly?
| "type": "string", | ||
| "description": "Unique identifier for the database" | ||
| }, | ||
| "name": { |
There was a problem hiding this comment.
name [](start = 9, length = 4)
Readonly?
Ordered readme.md contents from latest to oldest version. Marked response properties as readonly.
AutoRest linter results for ARM Related Validation Errors/WarningsThese errors are reported by the ARM team's validation tools, reachout to ARM RP API Review directly for any questions or concerns. File: specification/datamigration/resource-manager/readme.md
|
AutoRest linter results for SDK Related Validation Errors/WarningsThese errors are reported by the SDK team's validation tools, reachout to ADX Swagger Reviewers directly for any questions or concerns. File: specification/datamigration/resource-manager/readme.md
|
| "discriminator": "resultType" | ||
| }, | ||
| "MigrateSqlServerSqlDbTaskOutputMigrationLevel": { | ||
| "x-ms-discriminator-value": "MigrationLevelOutput", |
There was a problem hiding this comment.
Please add "description" for this type
| "StartMigrationScenarioServerRoleResult": { | ||
| "type": "object", | ||
| "description": "", | ||
| "properties": { |
There was a problem hiding this comment.
Please add "description" for this type
| "type": "string" | ||
| "type": "string", | ||
| "readOnly": true | ||
| }, |
There was a problem hiding this comment.
if this type is marked as readonly it cannot be also marked as required. Required means that client has to send it to server each time, readonly means client only receives this type and cannot send it back to server. Please fix.
|
The only big change from ARM standpoint is making some properties readonly. Since this change is made in a new api version, and the older version was preview, its fine. signing off! |
AutoRest linter results for SDK Related Validation Errors/WarningsThese errors are reported by the SDK team's validation tools, reachout to ADX Swagger Reviewers directly for any questions or concerns. File: specification/datamigration/resource-manager/readme.md
|
AutoRest linter results for ARM Related Validation Errors/WarningsThese errors are reported by the ARM team's validation tools, reachout to ARM RP API Review directly for any questions or concerns. File: specification/datamigration/resource-manager/readme.md
|
|
@binuj could you fix Linter errors? - https://travis-ci.org/Azure/azure-rest-api-specs/jobs/371826015 They have pretty good documentation. e.g. |
AutoRest linter results for SDK Related Validation Errors/WarningsThese errors are reported by the SDK team's validation tools, reachout to ADX Swagger Reviewers directly for any questions or concerns. File: specification/datamigration/resource-manager/readme.md
|
AutoRest linter results for ARM Related Validation Errors/WarningsThese errors are reported by the ARM team's validation tools, reachout to ARM RP API Review directly for any questions or concerns. File: specification/datamigration/resource-manager/readme.md
|
AutoRest linter results for ARM Related Validation Errors/WarningsThese errors are reported by the ARM team's validation tools, reachout to ARM RP API Review directly for any questions or concerns. File: specification/datamigration/resource-manager/readme.md
|
AutoRest linter results for SDK Related Validation Errors/WarningsThese errors are reported by the SDK team's validation tools, reachout to ADX Swagger Reviewers directly for any questions or concerns. File: specification/datamigration/resource-manager/readme.md
|
|
one left |
|
There are also bunch of missing documentation fields. They will be used in all the auto-generated languages as hints for developers so it is highly suggested to have human readable documentation text. You can see all the doc issues in this build https://travis-ci.org/Azure/azure-rest-api-specs/jobs/372255731. They start with |
AutoRest linter results for SDK Related Validation Errors/WarningsThese errors are reported by the SDK team's validation tools, reachout to ADX Swagger Reviewers directly for any questions or concerns. File: specification/datamigration/resource-manager/readme.md
|
AutoRest linter results for ARM Related Validation Errors/WarningsThese errors are reported by the ARM team's validation tools, reachout to ARM RP API Review directly for any questions or concerns. File: specification/datamigration/resource-manager/readme.md
|
|
@binuj please revert changes to the specs of the previous versions - no need to fix those issues in this PR. |
…only focused on stable 2018-04-19. Marked some properties as readonly in '2018-04-19\definitions\TasksCommon.json'
AutoRest linter results for SDK Related Validation Errors/WarningsThese errors are reported by the SDK team's validation tools, reachout to ADX Swagger Reviewers directly for any questions or concerns. File: specification/datamigration/resource-manager/readme.md
|
AutoRest linter results for ARM Related Validation Errors/WarningsThese errors are reported by the ARM team's validation tools, reachout to ARM RP API Review directly for any questions or concerns. File: specification/datamigration/resource-manager/readme.md
|
|
@binuj please fix Linter errors like |
|
ignore my last comment - errors are in previous preview specs and were marked by Linter due to description change in your current pr. |
This checklist is used to make sure that common issues in a pull request are addressed. This will expedite the process of getting your pull request merged and avoid extra work on your part to fix issues discovered during the review process.
PR information
api-versionin the path should match theapi-versionin the spec).Quality of Swagger