-
Notifications
You must be signed in to change notification settings - Fork 5.2k
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.
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
[Data Factory] data flow + debug session API swagger #7088
Conversation
In Testing, Please Ignore[Logs] (Generated from 3ff8cd5, Iteration 16)
|
Automation for azure-sdk-for-pythonA PR has been created for you based on this PR content. Once this PR will be merged, content will be added to your service PR: |
Can one of the admins verify this patch? |
Will have an API review with ARM team first |
Automation for azure-sdk-for-goA PR has been created for you based on this PR content. Once this PR will be merged, content will be added to your service PR: |
}, | ||
"304": { | ||
"description": "Not modified." | ||
}, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As per the RPC, GETs should always return 200 (unless there's a failure)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Got it, it's actually the same pattern as all other sub resources we have. I will remove it here and change our RP at the same time
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@majastrz 304 is for "If-None-Match" header.
{
| "name": "If-None-Match",
| "in": "header",
| "required": false,
| "type": "string",
| "description": "ETag of the dataset entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned."
| }
} | ||
} | ||
}, | ||
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/createDataFlowDebugSession": { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
createDataFlowDebugSession [](start = 128, length = 26)
You have several POST actions that perform various lifecycle operations (create, delete, query) on data flow debug sessions. Heavily relying on POST is generally an anti-pattern in ARM.
Have you considered modeling dataFlowDebugSessions as a proxy resource? If yes, why did you choose the POST approach? #Closed
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We don't want to treat dataFlowDebugSession as a proxy resource since it's a just a temporary session which users can perform some debugging actions. "Create", "AddDataFlow" and "Execute" needs to be POST actions though I can modify query to be get if ARM prefers that way. #Closed
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It seems that the sessionId is assigned by the backend, so it'll have to be POST.
In reply to: 325409815 [](ancestors = 325409815)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yep, reverted to post
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I added a couple of comments. Can you take a look?
Could you help to take a look again? Thanks! |
}, | ||
"x-ms-pageable": { | ||
"nextLinkName": "nextLink" | ||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@anuchandy, will this work with the generated SDK? Normally, this is reserved for GETs but this is a POST.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I added a comment. Please confirm with SDK reviewer to make sure POST will work with nextLink. Otherwise, it looks good from ARM side.
@jackmagic313 the codegen exceptions are getting thrown from autorest.common, I'm checking with core owner (you're in the loop). |
Latest improvements:
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Contribution checklist:
ARM API Review Checklist
Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs.
Please follow the link to find more details on API review process.