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

Jump to bottom

Adding Artifact rename api for resources Notebook,Pipeline,Dataflow, Dataset, SparkJobDefinition, SqlScripts and LinkedServices #11323

Merged
merged 12 commits into from
Nov 3, 2020
Merged

Adding Artifact rename api for resources Notebook,Pipeline,Dataflow, Dataset, SparkJobDefinition, SqlScripts and LinkedServices #11323

merged 12 commits into from
Nov 3, 2020

Conversation

srinuthati
Copy link
Contributor

@srinuthati srinuthati commented Oct 22, 2020 •
edited
Loading

Adding Artifact rename api for resources Notebook,Pipeline,Dataflow, Dataset, SparkJobDefinition, SqlScripts and LinkedServices

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

Contribution checklist:

If any further question about AME onboarding or validation tools, please view the FAQ.

ARM API Review Checklist

  • Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.

    • Adding new API(s)
    • Adding a new API version
    • Adding a new service

  • Please ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.

  • If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.

Breaking Change Review Checklist

If there are following updates in the PR, ensure to request an approval from API Review Board as defined in the Breaking Change Policy.

  • Removing API(s) in stable version
  • Removing properties in stable version
  • Removing API version(s) in stable version
  • Updating API in stable version with Breaking Change Validation errors
  • Updating API(s) in preview over 1 year

Please follow the link to find more details on PR review process.

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Oct 22, 2020 •
edited
Loading

Swagger Validation Report

️❌BreakingChange: 7 Errors, 0 Warnings failed [Detail] [Expand]

Rule Message
❌ 1038 - AddedPath The new version is adding a path that was not found in the old version.
New: Microsoft.Synapse/preview/2019-06-01-preview/artifacts.json#L206:5
❌ 1038 - AddedPath The new version is adding a path that was not found in the old version.
New: Microsoft.Synapse/preview/2019-06-01-preview/artifacts.json#L429:5
❌ 1038 - AddedPath The new version is adding a path that was not found in the old version.
New: Microsoft.Synapse/preview/2019-06-01-preview/artifacts.json#L652:5
❌ 1038 - AddedPath The new version is adding a path that was not found in the old version.
New: Microsoft.Synapse/preview/2019-06-01-preview/artifacts.json#L1546:5
❌ 1038 - AddedPath The new version is adding a path that was not found in the old version.
New: Microsoft.Synapse/preview/2019-06-01-preview/artifacts.json#L2018:5
❌ 1038 - AddedPath The new version is adding a path that was not found in the old version.
New: Microsoft.Synapse/preview/2019-06-01-preview/artifacts.json#L2279:5
❌ 1038 - AddedPath The new version is adding a path that was not found in the old version.
New: Microsoft.Synapse/preview/2019-06-01-preview/artifacts.json#L2590:5
️️✔️~[Staging] LintDiff succeeded [Detail] 
Validation passes for LintDiff.

️️✔️~[Staging] Avocado succeeded [Detail] 
Validation passes for Avocado.
️️✔️~[Staging] ModelValidation succeeded [Detail] 
Validation passes for ModelValidation.
️️✔️~[Staging] SemanticValidation succeeded [Detail] 
Validation passes for SemanticValidation.
Posted by Swagger Pipeline | How to fix these errors?

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@openapi-sdkautomation
Copy link

openapi-sdkautomation bot commented Oct 22, 2020 •
edited
Loading

azure-sdk-for-net - Release

No readme.md specification configuration files were found that are associated with the files modified in this pull request, or swagger_to_sdk section in readme.md is not configured

@openapi-sdkautomation
Copy link

openapi-sdkautomation bot commented Oct 22, 2020 •
edited
Loading

Azure CLI Extension Generation - Release

No readme.md specification configuration files were found that are associated with the files modified in this pull request, or swagger_to_sdk section in readme.md is not configured

@openapi-sdkautomation
Copy link

openapi-sdkautomation bot commented Oct 22, 2020 •
edited
Loading

azure-sdk-for-java - Release

No readme.md specification configuration files were found that are associated with the files modified in this pull request, or swagger_to_sdk section in readme.md is not configured

@openapi-sdkautomation
Copy link

openapi-sdkautomation bot commented Oct 22, 2020 •
edited
Loading

azure-sdk-for-js - Release

No readme.md specification configuration files were found that are associated with the files modified in this pull request, or swagger_to_sdk section in readme.md is not configured

@openapi-sdkautomation
Copy link

openapi-sdkautomation bot commented Oct 22, 2020 •
edited
Loading

azure-sdk-for-python - Release

No readme.md specification configuration files were found that are associated with the files modified in this pull request, or swagger_to_sdk section in readme.md is not configured

@openapi-sdkautomation
Copy link

openapi-sdkautomation bot commented Oct 22, 2020 •
edited
Loading

azure-sdk-for-python-track2 - Release

No readme.md specification configuration files were found that are associated with the files modified in this pull request, or swagger_to_sdk section in readme.md is not configured

@openapi-sdkautomation
Copy link

openapi-sdkautomation bot commented Oct 22, 2020 •
edited
Loading

azure-sdk-for-go - Release

No readme.md specification configuration files were found that are associated with the files modified in this pull request, or swagger_to_sdk section in readme.md is not configured

@openapi-sdkautomation
Copy link

openapi-sdkautomation bot commented Oct 22, 2020 •
edited
Loading

azure-resource-manager-schemas - Release

No readme.md specification configuration files were found that are associated with the files modified in this pull request, or swagger_to_sdk section in readme.md is not configured

@openapi-sdkautomation
Copy link

openapi-sdkautomation bot commented Oct 22, 2020 •
edited
Loading

Trenton Generation - Release

No readme.md specification configuration files were found that are associated with the files modified in this pull request, or swagger_to_sdk section in readme.md is not configured

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@srinuthati
Copy link
Contributor Author

Trenton Generation

No readme.md specification configuration files were found that are associated with the files modified in this pull request, or swagger_to_sdk section in readme.md is not configured

no readme updates

@srinuthati srinuthati closed this Oct 23, 2020
@srinuthati
Copy link
Contributor Author

Trenton Generation

No readme.md specification configuration files were found that are associated with the files modified in this pull request, or swagger_to_sdk section in readme.md is not configured

no readme updates needed

@srinuthati srinuthati reopened this Oct 23, 2020
@srinuthati
Update artifacts.json
eef7a4f 
modifying rename method to post
@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@johanste
Copy link
Member

Adding @fearthecowboy as a reviewers since I'll be off grid for a couple of weeks.

@fearthecowboy
Copy link
Member

There are a couple other things that I'm concerned about in this service defintion.

OperationIDs should not contain the resource name in both the prefix and the suffix.

"operationId": "LinkedService_RenameLinkedService", this really should just be "operationId": "LinkedService_Rename",

This bad pattern is all over this swagger (ie "operationId": "Dataset_CreateOrUpdateDataset", -- this is not the appropriate name, it should always be "operationId": "Dataset_CreateOrUpdate",)

Further, the prefix of the operationId should be in plural (ie, "operationId": "Datasets_CreateOrUpdate", not Dataset_)

Oddly enough, you name the examples with the correct name:

    ],
        "operationId": "Dataset_DeleteDataset",   // This should have been 'Datasets_Delete'
        "x-ms-examples": {
          "Datasets_Delete": {
            "$ref": "./examples/Datasets_Delete.json"    // Datasets_Delete is good!
          }
        },
        "description": "Deletes a dataset.",

With the operationId not conforming to the naming standard, the SDKs might not be the correct tense for the operation groups.

fearthecowboy
fearthecowboy suggested changes Nov 2, 2020
View reviewed changes
Copy link
Member

@fearthecowboy fearthecowboy left a comment

Choose a reason for hiding this comment

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

Definitely need to add constraints to the newName property in the request.

I'd like to see the operationId conform to the standard of <PLURAL>_<OPERATION> .

Removing the resource name from the operationID suffix would probably be a really good idea.

Consider If-Match on the rename operations to prevent unintended accidental renames of a resource (not critical, it's likely an edge case)

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Nov 2, 2020 •
edited
Loading

Swagger Generation Artifacts

️️✔️~[Staging] ApiDocPreview succeeded [Detail] 
 Please click here to preview with your @microsoft account.
Posted by Swagger Pipeline | How to fix these errors?

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@srinuthati
Copy link
Contributor Author

srinuthati commented Nov 2, 2020 •
edited
Loading

Definitely need to add constraints to the newName property in the request.
done
I'd like to see the operationId conform to the standard of <PLURAL>_<OPERATION> .
done
Removing the resource name from the operationID suffix would probably be a really good idea.
done
Consider If-Match on the rename operations to prevent unintended accidental renames of a resource (not critical, it's likely an edge case)This is a passthrough api and the check is already there at implementation api

@chiragg4u
Copy link
Contributor

Please go through the ARM API Review Checklist. These steps are required before review can be continued.

@srinuthati
Copy link
Contributor Author

Please go through the ARM API Review Checklist. These steps are required before review can be continued.

This is not ARM api its by mistake labeled as ARM API

@anuchandy anuchandy removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Nov 3, 2020
@anuchandy
Copy link
Member

service is in preview and not GA-ed yet, hence removing the "New api-version required" tag.

@JeffreyRichter JeffreyRichter self-requested a review November 3, 2020 18:43
@JeffreyRichter JeffreyRichter added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Nov 3, 2020
@lmazuel lmazuel merged commit f87c55b into Azure:master Nov 3, 2020
JeffreyRichter
JeffreyRichter reviewed Nov 3, 2020
View reviewed changes
Copy link
Member

@JeffreyRichter JeffreyRichter left a comment

Choose a reason for hiding this comment

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

I approve this PR

@idear1203 idear1203 mentioned this pull request Nov 4, 2020
Merged
11 tasks
giromm2ms pushed a commit to giromm2ms/azure-rest-api-specs that referenced this pull request Dec 20, 2020
@srinuthati
Adding Artifact rename api for resources Notebook,Pipeline,Dataflow, …
c793349 
…Dataset, SparkJobDefinition, SqlScripts and LinkedServices (Azure#11323)

* Update artifacts.json

* Adding examples for artifact rename

* removed spaces

* fixing breaking changes

* fixing breaking changes

* fixing swagger semantic and model vaidation errors

* fixing model vaidation error

* fixing prettier issues

* Update artifacts.json

modifying rename method to post

* resolving comments

* prettier check

Co-authored-by: srinivas thatipamula <srthatip@microsoft.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@JeffreyRichter JeffreyRichter JeffreyRichter left review comments

@fearthecowboy fearthecowboy fearthecowboy approved these changes

@anuchandy anuchandy anuchandy approved these changes

@johanste johanste Awaiting requested review from johanste

Assignees

@anuchandy anuchandy

Labels
Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
7 participants
@srinuthati @johanste @fearthecowboy @chiragg4u @anuchandy @JeffreyRichter @lmazuel