diff --git a/cSpell.json b/cSpell.json index 1cfbe88a8e8f..00df0a44e575 100644 --- a/cSpell.json +++ b/cSpell.json @@ -897,8 +897,6 @@ "filename": "**/specification/purview/data-plane/Azure.Analytics.Purview.Workflow/preview/2022-05-01-preview/purviewWorkflow.json", "words": [ "userrequests", - "DSAR", - "dsar", "workflowruns", "workflowtasks" ] diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Workflow/preview/2022-05-01-preview/examples/ClaimDSARTaskRequest.json b/specification/purview/data-plane/Azure.Analytics.Purview.Workflow/preview/2022-05-01-preview/examples/ClaimDSARTaskRequest.json deleted file mode 100644 index ea947a6ee4a8..000000000000 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Workflow/preview/2022-05-01-preview/examples/ClaimDSARTaskRequest.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "parameters": { - "api-version": "2022-05-01-preview", - "taskId": "d5bd0215-df84-4245-8e18-3a8f012be376", - "dsarTaskClaimCommand": { - "comment": "Thanks!" - } - }, - "responses": { - "200": {} - } -} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Workflow/preview/2022-05-01-preview/examples/GetWorkflowTask.json b/specification/purview/data-plane/Azure.Analytics.Purview.Workflow/preview/2022-05-01-preview/examples/GetWorkflowTask.json index 72b245098d94..5bfa0ce3e2fb 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Workflow/preview/2022-05-01-preview/examples/GetWorkflowTask.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Workflow/preview/2022-05-01-preview/examples/GetWorkflowTask.json @@ -57,7 +57,9 @@ "status": "Pending", "approvers": { "eece94d9-0619-4669-bb8a-d6ecec5220bc": { - "reply": "pending" + "reply": "Approved", + "comment": "Thanks!", + "responseTime": "2023-02-06T09:57:46.056708512Z" } } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Workflow/preview/2022-05-01-preview/examples/ListWorkflowTasks.json b/specification/purview/data-plane/Azure.Analytics.Purview.Workflow/preview/2022-05-01-preview/examples/ListWorkflowTasks.json index c9c8f144bcba..c415fb8d76d2 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Workflow/preview/2022-05-01-preview/examples/ListWorkflowTasks.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Workflow/preview/2022-05-01-preview/examples/ListWorkflowTasks.json @@ -50,7 +50,7 @@ "status": "Pending", "approvers": { "eece94d9-0619-4669-bb8a-d6ecec5220bc": { - "reply": "pending" + "reply": "Pending" } } } @@ -96,7 +96,7 @@ "status": "Pending", "approvers": { "eece94d9-0619-4669-bb8a-d6ecec5220bc": { - "reply": "pending" + "reply": "Pending" } } } @@ -142,7 +142,7 @@ "status": "Pending", "approvers": { "eece94d9-0619-4669-bb8a-d6ecec5220bc": { - "reply": "pending" + "reply": "Pending" } } } @@ -165,7 +165,7 @@ "status": "Pending", "approvers": { "eece94d9-0619-4669-bb8a-d6ecec5220bc": { - "reply": "pending" + "reply": "Pending" } } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Workflow/preview/2022-05-01-preview/examples/ReleaseDSARTaskRequest.json b/specification/purview/data-plane/Azure.Analytics.Purview.Workflow/preview/2022-05-01-preview/examples/ReleaseDSARTaskRequest.json deleted file mode 100644 index 75739750032b..000000000000 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Workflow/preview/2022-05-01-preview/examples/ReleaseDSARTaskRequest.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "parameters": { - "api-version": "2022-05-01-preview", - "taskId": "5cc7992a-7f5e-11ed-a1eb-0242ac120002", - "dsarTaskReleaseCommand": { - "comment": "Thanks!" - } - }, - "responses": { - "200": {} - } -} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Workflow/preview/2022-05-01-preview/examples/UpdateTaskRequest.json b/specification/purview/data-plane/Azure.Analytics.Purview.Workflow/preview/2022-05-01-preview/examples/UpdateTaskRequest.json index febed1307656..547a8c320e31 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Workflow/preview/2022-05-01-preview/examples/UpdateTaskRequest.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Workflow/preview/2022-05-01-preview/examples/UpdateTaskRequest.json @@ -3,7 +3,7 @@ "api-version": "2022-05-01-preview", "taskId": "d5bd0215-df84-4245-8e18-3a8f012be376", "taskUpdateCommand": { - "newStatus": "In Progress", + "newStatus": "InProgress", "comment": "Thanks!" } }, diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Workflow/preview/2022-05-01-preview/purviewWorkflow.json b/specification/purview/data-plane/Azure.Analytics.Purview.Workflow/preview/2022-05-01-preview/purviewWorkflow.json index a1076221aea6..a12fc6d3a192 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Workflow/preview/2022-05-01-preview/purviewWorkflow.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Workflow/preview/2022-05-01-preview/purviewWorkflow.json @@ -277,9 +277,6 @@ { "$ref": "#/parameters/runStatuses" }, - { - "$ref": "#/parameters/userRequestIds" - }, { "$ref": "#/parameters/workflowIds" }, @@ -419,7 +416,9 @@ "type": "string", "enum": [ "createdTime desc", - "createdTime asc" + "createdTime asc", + "requestor desc", + "requestor asc" ], "x-ms-enum": { "name": "orderby", @@ -619,7 +618,7 @@ "WorkflowTasks" ], "description": "Update the status of a workflow task request.", - "operationId": "UpdateTaskRequest", + "operationId": "UpdateTaskStatus", "x-ms-examples": { "TaskRequest_Update": { "$ref": "./examples/UpdateTaskRequest.json" @@ -654,90 +653,6 @@ } } } - }, - "/workflowtasks/{taskId}/claim-task": { - "post": { - "tags": [ - "WorkflowTasks" - ], - "description": "Claim a DSAR task request.", - "operationId": "ClaimDSARTaskRequest", - "x-ms-examples": { - "DSARTaskRequest_Claim": { - "$ref": "./examples/ClaimDSARTaskRequest.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/taskId" - }, - { - "name": "dsarTaskClaimCommand", - "in": "body", - "required": true, - "description": "Request body of claiming DSAR task request.", - "schema": { - "$ref": "#/definitions/DSARTaskClaimCommand" - } - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "OK" - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/workflowtasks/{taskId}/release-task": { - "post": { - "tags": [ - "WorkflowTasks" - ], - "description": "Release a DSAR task request.", - "operationId": "ReleaseDSARTaskRequest", - "x-ms-examples": { - "DSARTaskRequest_Release": { - "$ref": "./examples/ReleaseDSARTaskRequest.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/taskId" - }, - { - "name": "dsarTaskReleaseCommand", - "in": "body", - "required": true, - "description": "Request body of releasing DSAR task request.", - "schema": { - "$ref": "#/definitions/DSARTaskReleaseCommand" - } - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "OK" - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } } }, "definitions": { @@ -807,10 +722,6 @@ "required": [ "id", "triggers", - "createdTime", - "createdBy", - "lastUpdateTime", - "updatedBy", "name", "isEnabled", "description" @@ -835,9 +746,7 @@ "when_term_update_is_requested", "when_terms_import_is_requested", "when_data_access_grant_is_requested", - "when_asset_update_is_requested", - "when_dsar_deletion_is_requested", - "when_dsar_export_is_requested" + "when_asset_update_is_requested" ], "x-ms-enum": { "name": "TriggerType", @@ -1132,9 +1041,7 @@ "DeleteTerm", "ImportTerms", "UpdateAsset", - "GrantDataAccess", - "DSARDelete", - "DSARExport" + "GrantDataAccess" ], "x-ms-enum": { "name": "WorkflowRunPayloadType", @@ -1271,8 +1178,7 @@ "description": "The workflow task type.", "enum": [ "Approval", - "SimpleTask", - "DsarTask" + "SimpleTask" ], "x-ms-enum": { "name": "TaskType", @@ -1418,9 +1324,7 @@ "DeleteTerm", "ImportTerms", "UpdateAsset", - "GrantDataAccess", - "DSARDelete", - "DSARExport" + "GrantDataAccess" ], "x-ms-enum": { "name": "TaskPayloadType", @@ -1436,9 +1340,7 @@ "DeleteTerm", "ImportTerms", "UpdateAsset", - "GrantDataAccess", - "DSARDelete", - "DSARExport" + "GrantDataAccess" ], "x-ms-enum": { "name": "OperationType", @@ -1510,7 +1412,7 @@ }, "approvers": { "type": "object", - "items": { + "additionalProperties": { "$ref": "#/definitions/ApproverResponse" }, "description": "The list of approvers with reply." @@ -1530,9 +1432,9 @@ "type": "string", "description": "The response for an approval task.", "enum": [ - "approved", - "rejected", - "pending" + "Approved", + "Rejected", + "Pending" ], "x-ms-enum": { "name": "ApprovalResponse", @@ -1615,135 +1517,9 @@ "changeHistory" ] }, - "DsarTask": { - "x-ms-discriminator-value": "DsarTask", - "description": "The workflow dsar task properties.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/WorkflowTask" - }, - { - "type": "object", - "properties": { - "taskDetail": { - "$ref": "#/definitions/DSARTaskDetail" - } - } - } - ] - }, - "DSARTaskDetail": { - "type": "object", - "description": "Workflow dsar task details.", - "properties": { - "taskBody": { - "type": "string", - "description": "The dsar task body." - }, - "assignedTo": { - "type": "array", - "description": "The users or groups were assigned the dsar task.", - "items": { - "type": "string", - "format": "uuid" - } - }, - "claimedBy": { - "type": "string", - "description": "The user who claimed the dsar task.", - "format": "uuid" - }, - "approvers": { - "type": "array", - "description": "The list of approvers.", - "items": { - "type": "string", - "description": "The approver of Dsar task.", - "format": "uuid" - } - }, - "dsarId": { - "type": "string", - "description": "The dsar id.", - "format": "uuid" - }, - "dsarTaskId": { - "type": "string", - "description": "The dsar task id.", - "format": "uuid" - }, - "status": { - "type": "string", - "description": "The dsar task status.", - "enum": [ - "NotStarted", - "InProgress", - "Completed", - "NotApplicable", - "Approved", - "Reopened" - ], - "x-ms-enum": { - "name": "DSARTaskStatus", - "modelAsString": true - } - }, - "changeHistory": { - "type": "array", - "items": { - "$ref": "#/definitions/TaskChangeEvent" - } - } - }, - "required": [ - "taskBody", - "assignedTo", - "approvers", - "dsarId", - "dsarTaskId", - "status", - "changeHistory" - ] - }, "TaskChangeEvent": { "type": "object", - "description": "History of changes made on task.", - "properties": { - "updatedBy": { - "type": "string", - "format": "uuid" - }, - "updatedTime": { - "type": "string", - "format": "date-time" - }, - "type": { - "type": "string", - "enum": [ - "ApproveApproval", - "RejectApproval", - "Reassign", - "ChangeTaskStatus", - "ClaimTask", - "ReleaseTask" - ], - "x-ms-enum": { - "name": "TaskChangeEventType", - "modelAsString": true - } - }, - "change": { - "type": "object", - "description": "The changes made on this task." - } - }, - "required": [ - "updatedBy", - "updatedTime", - "type", - "change" - ] + "description": "History of changes made on task." }, "ApprovalResponseComment": { "type": "object", @@ -1790,8 +1566,8 @@ "type": "string", "description": "The new status will be used to update the task.", "enum": [ - "Not Started", - "In Progress", + "NotStarted", + "InProgress", "Completed", "Canceled" ], @@ -1809,24 +1585,6 @@ "newStatus" ] }, - "DSARTaskClaimCommand": { - "type": "object", - "properties": { - "comment": { - "type": "string", - "description": "The comment when claiming a DSAR task." - } - } - }, - "DSARTaskReleaseCommand": { - "type": "object", - "properties": { - "comment": { - "type": "string", - "description": "The comment when releasing a DSAR task." - } - } - }, "ErrorResponse": { "description": "Default error response model", "type": "object", @@ -1964,8 +1722,7 @@ "type": "string", "enum": [ "approval", - "simpleTask", - "dsarTask" + "simpleTask" ], "x-ms-enum": { "name": "TaskType", @@ -1986,17 +1743,6 @@ "description": "Filter items by workflow id list.", "x-ms-parameter-location": "method" }, - "userRequestIds": { - "name": "userRequestIds", - "in": "query", - "required": false, - "type": "array", - "items": { - "type": "string" - }, - "description": "Filter items by user request id list.", - "x-ms-parameter-location": "method" - }, "runStatuses": { "name": "runStatuses", "in": "query",