acryl-datahub-cloud 0.3.13rc3__py3-none-any.whl → 0.3.13rc5__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.

This version of acryl-datahub-cloud might be problematic. Click here for more details.

Files changed (16) hide show
  1. acryl_datahub_cloud/_codegen_config.json +1 -1
  2. acryl_datahub_cloud/metadata/_urns/urn_defs.py +56 -0
  3. acryl_datahub_cloud/metadata/com/linkedin/pegasus2avro/actionworkflow/__init__.py +53 -0
  4. acryl_datahub_cloud/metadata/com/linkedin/pegasus2avro/metadata/key/__init__.py +2 -0
  5. acryl_datahub_cloud/metadata/schema.avsc +666 -33
  6. acryl_datahub_cloud/metadata/schema_classes.py +1077 -1
  7. acryl_datahub_cloud/metadata/schemas/ActionRequestInfo.avsc +136 -1
  8. acryl_datahub_cloud/metadata/schemas/ActionWorkflowInfo.avsc +683 -0
  9. acryl_datahub_cloud/metadata/schemas/ActionWorkflowKey.avsc +21 -0
  10. acryl_datahub_cloud/metadata/schemas/MetadataChangeEvent.avsc +136 -1
  11. acryl_datahub_cloud/metadata/schemas/NotificationRequest.avsc +4 -0
  12. {acryl_datahub_cloud-0.3.13rc3.dist-info → acryl_datahub_cloud-0.3.13rc5.dist-info}/METADATA +38 -38
  13. {acryl_datahub_cloud-0.3.13rc3.dist-info → acryl_datahub_cloud-0.3.13rc5.dist-info}/RECORD +16 -13
  14. {acryl_datahub_cloud-0.3.13rc3.dist-info → acryl_datahub_cloud-0.3.13rc5.dist-info}/WHEEL +0 -0
  15. {acryl_datahub_cloud-0.3.13rc3.dist-info → acryl_datahub_cloud-0.3.13rc5.dist-info}/entry_points.txt +0 -0
  16. {acryl_datahub_cloud-0.3.13rc3.dist-info → acryl_datahub_cloud-0.3.13rc5.dist-info}/top_level.txt +0 -0
acryl_datahub_cloud/metadata/schema.avsc CHANGED
@@ -4200,7 +4200,7 @@
4200
4200
  },
4201
4201
  "type": "string",
4202
4202
  "name": "type",
4203
- "doc": "The type of the action request, for example 'TAG_ASSOCIATION'"
4203
+ "doc": "The type of the action request, for example 'TAG_ASSOCIATION', 'WORKFLOW_FORM_REQUEST'"
4204
4204
  },
4205
4205
  {
4206
4206
  "Searchable": {
@@ -4957,6 +4957,141 @@
4957
4957
  "name": "dataContractProposal",
4958
4958
  "default": null,
4959
4959
  "doc": "A proposal to create or modify a Data Contract"
4960
+ },
4961
+ {
4962
+ "type": [
4963
+ "null",
4964
+ {
4965
+ "type": "record",
4966
+ "name": "ActionWorkflowFormRequest",
4967
+ "namespace": "com.linkedin.pegasus2avro.actionworkflow",
4968
+ "fields": [
4969
+ {
4970
+ "Searchable": {
4971
+ "fieldName": "actionWorkflow"
4972
+ },
4973
+ "java": {
4974
+ "class": "com.linkedin.pegasus2avro.common.urn.Urn"
4975
+ },
4976
+ "Urn": "Urn",
4977
+ "type": "string",
4978
+ "name": "workflow",
4979
+ "doc": "The urn of the associated access request workflow."
4980
+ },
4981
+ {
4982
+ "Searchable": {
4983
+ "fieldName": "workflowCategory"
4984
+ },
4985
+ "type": {
4986
+ "type": "enum",
4987
+ "symbolDocs": {
4988
+ "ACCESS": "Workflow for requesting access to a resource, such as a dataset or data job.\nRequires the `access` field to be populated with specific access parameters.",
4989
+ "CUSTOM": "Custom, non-access related workflow. For example, may be used to model workflows like\nasset creation, asset cleanup or deletion, etc."
4990
+ },
4991
+ "name": "ActionWorkflowCategory",
4992
+ "namespace": "com.linkedin.pegasus2avro.actionworkflow",
4993
+ "symbols": [
4994
+ "ACCESS",
4995
+ "CUSTOM"
4996
+ ]
4997
+ },
4998
+ "name": "category",
4999
+ "doc": "The category of the workflow. \nPrimarily used for searching / filtering action requests."
5000
+ },
5001
+ {
5002
+ "Searchable": {
5003
+ "fieldName": "customWorkflowCategory"
5004
+ },
5005
+ "type": [
5006
+ "null",
5007
+ "string"
5008
+ ],
5009
+ "name": "customCategory",
5010
+ "default": null,
5011
+ "doc": "The custom category of the workflow, if category is custom.\nPrimarily used for searching / filtering action requests."
5012
+ },
5013
+ {
5014
+ "type": {
5015
+ "type": "array",
5016
+ "items": {
5017
+ "type": "record",
5018
+ "name": "ActionWorkflowFormRequestField",
5019
+ "namespace": "com.linkedin.pegasus2avro.actionworkflow",
5020
+ "fields": [
5021
+ {
5022
+ "type": "string",
5023
+ "name": "id",
5024
+ "doc": "Workflow-local id for the field"
5025
+ },
5026
+ {
5027
+ "type": {
5028
+ "type": "array",
5029
+ "items": [
5030
+ "string",
5031
+ "double"
5032
+ ]
5033
+ },
5034
+ "name": "values",
5035
+ "doc": "Value, reused model from structured properties. Empty if no response was provided."
5036
+ }
5037
+ ],
5038
+ "doc": "Simply capture the field id + the value."
5039
+ }
5040
+ },
5041
+ "name": "fields",
5042
+ "doc": "Custom fields provided by the user making the request if the action request is of type FORM_SUBMITTED\nEventually, these may need to become search indexed. For now, not indexed."
5043
+ },
5044
+ {
5045
+ "type": [
5046
+ "null",
5047
+ {
5048
+ "type": "record",
5049
+ "name": "ActionWorkflowRequestAccess",
5050
+ "namespace": "com.linkedin.pegasus2avro.actionworkflow",
5051
+ "fields": [
5052
+ {
5053
+ "Searchable": {},
5054
+ "type": [
5055
+ "null",
5056
+ "long"
5057
+ ],
5058
+ "name": "expiresAt",
5059
+ "default": null,
5060
+ "doc": "Expiration time for the action request (optional, if part of the template)."
5061
+ }
5062
+ ]
5063
+ }
5064
+ ],
5065
+ "name": "access",
5066
+ "default": null,
5067
+ "doc": "Details specific for access request workflow requests."
5068
+ },
5069
+ {
5070
+ "type": {
5071
+ "type": "record",
5072
+ "name": "ActionWorkflowRequestStepState",
5073
+ "namespace": "com.linkedin.pegasus2avro.actionworkflow",
5074
+ "fields": [
5075
+ {
5076
+ "Searchable": {
5077
+ "fieldName": "workflowStepId"
5078
+ },
5079
+ "type": "string",
5080
+ "name": "stepId",
5081
+ "doc": "The id of the current step in the workflow, which should be of type ACTION_REQUEST_REVIEW."
5082
+ }
5083
+ ]
5084
+ },
5085
+ "name": "stepState",
5086
+ "doc": "State related to steps. This should correspond to a step of type ACTION_REQUEST_REVIEW in the workflow \ndefinition."
5087
+ }
5088
+ ],
5089
+ "doc": "A request for an access workflow form to be reviewed.\n\nFor an access workflow of trigger type FORM, this action request currently represents the \"state\" \nof the workflow instance. \n\nIn the future, we may add more features like due dates, escalations, etc.\nIdeally, for now we are keeping these out of here."
5090
+ }
5091
+ ],
5092
+ "name": "workflowFormRequest",
5093
+ "default": null,
5094
+ "doc": "An action workflow form request."
4960
5095
  }
4961
5096
  ],
4962
5097
  "doc": "Parameters provided with a particular action request. Only one of the fields will be populated,\ndepending on the action request type."
@@ -6278,6 +6413,27 @@
6278
6413
  ],
6279
6414
  "doc": "Key for an asset Anomaly"
6280
6415
  },
6416
+ {
6417
+ "type": "record",
6418
+ "Aspect": {
6419
+ "name": "actionWorkflowKey",
6420
+ "keyForEntity": "actionWorkflow",
6421
+ "entityCategory": "internal",
6422
+ "entityAspects": [
6423
+ "actionWorkflowInfo"
6424
+ ]
6425
+ },
6426
+ "name": "ActionWorkflowKey",
6427
+ "namespace": "com.linkedin.pegasus2avro.metadata.key",
6428
+ "fields": [
6429
+ {
6430
+ "type": "string",
6431
+ "name": "id",
6432
+ "doc": " The unique identifier for the workflow "
6433
+ }
6434
+ ],
6435
+ "doc": "Key for an ActionRequestWorkflow"
6436
+ },
6281
6437
  {
6282
6438
  "type": "record",
6283
6439
  "Aspect": {
@@ -15824,7 +15980,9 @@
15824
15980
  "type": {
15825
15981
  "type": "enum",
15826
15982
  "symbolDocs": {
15983
+ "BROADCAST_ACTION_WORKFLOW_FORM_REQUEST_STATUS_CHANGE": "Broadcast that an action workflow form request has been completed (approved or denied).",
15827
15984
  "BROADCAST_ASSERTION_STATUS_CHANGE": "Assertion change notification template.",
15985
+ "BROADCAST_NEW_ACTION_WORKFLOW_FORM_REQUEST": "Broadcast that a new action workflow form request has been created or needs review.",
15828
15986
  "BROADCAST_NEW_INCIDENT_UPDATE": "Updates the broadcasted incident if possible.",
15829
15987
  "CUSTOM": "Legacy template types to support backwards compatibility.",
15830
15988
  "OWNERSHIP_CHANGE": "Ownership change notification template."
@@ -15843,6 +16001,8 @@
15843
16001
  "BROADCAST_NEW_PROPOSAL",
15844
16002
  "BROADCAST_PROPOSAL_STATUS_CHANGE",
15845
16003
  "BROADCAST_COMPLIANCE_FORM_PUBLISH",
16004
+ "BROADCAST_NEW_ACTION_WORKFLOW_FORM_REQUEST",
16005
+ "BROADCAST_ACTION_WORKFLOW_FORM_REQUEST_STATUS_CHANGE",
15846
16006
  "INVALID_TEMPLATE"
15847
16007
  ],
15848
16008
  "doc": "Possible notification template types."
@@ -25593,6 +25753,509 @@
25593
25753
  ],
25594
25754
  "doc": "A feedback log of anomalies detected by a monitor\nNOTE: this is an immutable log. The most recent entry for a given run can be used to determine the state of the anomaly."
25595
25755
  },
25756
+ {
25757
+ "type": "record",
25758
+ "Aspect": {
25759
+ "name": "actionWorkflowInfo"
25760
+ },
25761
+ "name": "ActionWorkflowInfo",
25762
+ "namespace": "com.linkedin.pegasus2avro.actionworkflow",
25763
+ "fields": [
25764
+ {
25765
+ "Searchable": {},
25766
+ "type": "string",
25767
+ "name": "name",
25768
+ "doc": "Display name of the workflow"
25769
+ },
25770
+ {
25771
+ "Searchable": {},
25772
+ "type": "com.linkedin.pegasus2avro.actionworkflow.ActionWorkflowCategory",
25773
+ "name": "category",
25774
+ "doc": "Top-level category of the workflow, e.g. ACCESS"
25775
+ },
25776
+ {
25777
+ "Searchable": {},
25778
+ "type": [
25779
+ "null",
25780
+ "string"
25781
+ ],
25782
+ "name": "customCategory",
25783
+ "default": null,
25784
+ "doc": "Custom category for the workflow, if applicable.\n\nThis is used to group workflows that are not part of the standard types.\nShould be provided when the type is CUSTOM."
25785
+ },
25786
+ {
25787
+ "type": [
25788
+ "null",
25789
+ "string"
25790
+ ],
25791
+ "name": "description",
25792
+ "default": null,
25793
+ "doc": "Description of the workflow. \nIf this is based on a Form trigger, this will be displayed to users when completing the form. "
25794
+ },
25795
+ {
25796
+ "type": {
25797
+ "type": "record",
25798
+ "name": "ActionWorkflowTrigger",
25799
+ "namespace": "com.linkedin.pegasus2avro.actionworkflow",
25800
+ "fields": [
25801
+ {
25802
+ "Searchable": {
25803
+ "fieldName": "triggerType"
25804
+ },
25805
+ "type": {
25806
+ "type": "enum",
25807
+ "symbolDocs": {
25808
+ "FORM_SUBMITTED": "The only trigger type currently supported - a workflow request form is submitted successfully. \nThis enables admins to create forms and display them on various entrypoints. \nThe form is also captured in the field \"form\" below. "
25809
+ },
25810
+ "name": "ActionWorkflowTriggerType",
25811
+ "namespace": "com.linkedin.pegasus2avro.actionworkflow",
25812
+ "symbols": [
25813
+ "FORM_SUBMITTED"
25814
+ ]
25815
+ },
25816
+ "name": "type",
25817
+ "doc": "A type of step / task / node in the Action Workflow. "
25818
+ },
25819
+ {
25820
+ "type": [
25821
+ "null",
25822
+ {
25823
+ "type": "record",
25824
+ "name": "ActionWorkflowForm",
25825
+ "namespace": "com.linkedin.pegasus2avro.actionworkflow",
25826
+ "fields": [
25827
+ {
25828
+ "type": {
25829
+ "type": "array",
25830
+ "items": {
25831
+ "type": "record",
25832
+ "name": "ActionWorkflowEntrypoint",
25833
+ "namespace": "com.linkedin.pegasus2avro.actionworkflow",
25834
+ "fields": [
25835
+ {
25836
+ "Searchable": {
25837
+ "fieldName": "entrypointType"
25838
+ },
25839
+ "type": {
25840
+ "type": "enum",
25841
+ "symbolDocs": {
25842
+ "ENTITY_PROFILE": " Visible on the entity profile page. For all valid entity types specified in the parent object. ",
25843
+ "HOME": " Visible on the home page to all users. "
25844
+ },
25845
+ "name": "ActionWorkflowEntrypointType",
25846
+ "namespace": "com.linkedin.pegasus2avro.actionworkflow",
25847
+ "symbols": [
25848
+ "HOME",
25849
+ "ENTITY_PROFILE"
25850
+ ]
25851
+ },
25852
+ "name": "type",
25853
+ "doc": "The type of entry point for the action request workflow.\nThis determines where the action request workflow will be displayed."
25854
+ },
25855
+ {
25856
+ "type": "string",
25857
+ "name": "label",
25858
+ "doc": "The label for the entry point, which is displayed to users.\nThis should be a user-friendly name that describes the action request."
25859
+ },
25860
+ {
25861
+ "type": [
25862
+ "null",
25863
+ "com.linkedin.pegasus2avro.metadata.query.filter.Filter"
25864
+ ],
25865
+ "name": "filter",
25866
+ "default": null,
25867
+ "doc": "Additional filter criteria to determine when the entry point should be displayed.\n\nNot yet supported (but will be in the future)."
25868
+ }
25869
+ ],
25870
+ "doc": "The entry point arguments for the action request workflowform.\nIn the future, we may extend this model to support more granular entry point filters."
25871
+ }
25872
+ },
25873
+ "name": "entrypoints",
25874
+ "doc": "Entrypoints for form submission."
25875
+ },
25876
+ {
25877
+ "Searchable": {
25878
+ "/*": {
25879
+ "fieldName": "entityTypes",
25880
+ "fieldType": "URN"
25881
+ }
25882
+ },
25883
+ "Urn": "Urn",
25884
+ "urn_is_array": true,
25885
+ "type": [
25886
+ "null",
25887
+ {
25888
+ "type": "array",
25889
+ "items": "string"
25890
+ }
25891
+ ],
25892
+ "name": "entityTypes",
25893
+ "default": null,
25894
+ "doc": "The valid entity type URNs that can be associated with a Workflow Form.\nIf provided, this will require that an entity of one of the provided types is specified when completing the form.\n\nIf no entity types are provided, the workflow form can be submitted without specifying an entity. In general, this should\nbe populated for workflows of type ACCESS to enable users to request access to a specific entity!\n\nIf specified, the associated action requests for this workflow will contain an URN of the corresponding type inside of\nthe `resource` field.\n\nNote that associating multiple entities with a single Action Request is not yet supported."
25895
+ },
25896
+ {
25897
+ "type": {
25898
+ "type": "array",
25899
+ "items": {
25900
+ "type": "record",
25901
+ "name": "ActionWorkflowField",
25902
+ "namespace": "com.linkedin.pegasus2avro.actionworkflow",
25903
+ "fields": [
25904
+ {
25905
+ "type": "string",
25906
+ "name": "id",
25907
+ "doc": "Workflow-local id for the field"
25908
+ },
25909
+ {
25910
+ "type": "string",
25911
+ "name": "name",
25912
+ "doc": "The display name or label for the field, for rendering"
25913
+ },
25914
+ {
25915
+ "type": [
25916
+ "null",
25917
+ "string"
25918
+ ],
25919
+ "name": "description",
25920
+ "default": null,
25921
+ "doc": "The description for the field, for rendering"
25922
+ },
25923
+ {
25924
+ "java": {
25925
+ "class": "com.linkedin.pegasus2avro.common.urn.Urn"
25926
+ },
25927
+ "Urn": "Urn",
25928
+ "type": "string",
25929
+ "name": "valueType",
25930
+ "doc": "The urn of the value type for the values - reused from structured properties.\nAlso, used for rendering"
25931
+ },
25932
+ {
25933
+ "Urn": "Urn",
25934
+ "urn_is_array": true,
25935
+ "type": [
25936
+ "null",
25937
+ {
25938
+ "type": "array",
25939
+ "items": "string"
25940
+ }
25941
+ ],
25942
+ "name": "allowedEntityTypes",
25943
+ "default": null,
25944
+ "doc": "The urns for allowed entity types."
25945
+ },
25946
+ {
25947
+ "type": [
25948
+ "null",
25949
+ {
25950
+ "type": "array",
25951
+ "items": {
25952
+ "type": "record",
25953
+ "name": "PropertyValue",
25954
+ "namespace": "com.linkedin.pegasus2avro.structured",
25955
+ "fields": [
25956
+ {
25957
+ "type": [
25958
+ "string",
25959
+ "double"
25960
+ ],
25961
+ "name": "value"
25962
+ },
25963
+ {
25964
+ "type": [
25965
+ "null",
25966
+ "string"
25967
+ ],
25968
+ "name": "description",
25969
+ "default": null,
25970
+ "doc": "Optional description of the property value"
25971
+ }
25972
+ ]
25973
+ }
25974
+ }
25975
+ ],
25976
+ "name": "allowedValues",
25977
+ "default": null,
25978
+ "doc": "A list of allowed values that the property is allowed to take.\nIf this is not specified, then the property can take any value of given type."
25979
+ },
25980
+ {
25981
+ "type": {
25982
+ "type": "enum",
25983
+ "name": "PropertyCardinality",
25984
+ "namespace": "com.linkedin.pegasus2avro.structured",
25985
+ "symbols": [
25986
+ "SINGLE",
25987
+ "MULTIPLE"
25988
+ ]
25989
+ },
25990
+ "name": "cardinality",
25991
+ "doc": "Whether or not multiple values are allowed."
25992
+ },
25993
+ {
25994
+ "type": "boolean",
25995
+ "name": "required",
25996
+ "default": false,
25997
+ "doc": "Whether the field is required or not."
25998
+ },
25999
+ {
26000
+ "type": [
26001
+ "null",
26002
+ {
26003
+ "type": "record",
26004
+ "name": "ActionWorkflowFieldCondition",
26005
+ "namespace": "com.linkedin.pegasus2avro.actionworkflow",
26006
+ "fields": [
26007
+ {
26008
+ "type": {
26009
+ "type": "enum",
26010
+ "symbolDocs": {
26011
+ "SINGLE_FIELD_VALUE": "The field should be shown if the value of a previously completed field matches the specified value."
26012
+ },
26013
+ "name": "ActionWorkflowFieldConditionType",
26014
+ "namespace": "com.linkedin.pegasus2avro.actionworkflow",
26015
+ "symbols": [
26016
+ "SINGLE_FIELD_VALUE"
26017
+ ]
26018
+ },
26019
+ "name": "type",
26020
+ "doc": "The type of field condition"
26021
+ },
26022
+ {
26023
+ "type": [
26024
+ "null",
26025
+ {
26026
+ "type": "record",
26027
+ "name": "ActionWorkflowSingleFieldValueCondition",
26028
+ "namespace": "com.linkedin.pegasus2avro.actionworkflow",
26029
+ "fields": [
26030
+ {
26031
+ "type": "string",
26032
+ "name": "field",
26033
+ "doc": "The id / name of the field that the criterion refers to"
26034
+ },
26035
+ {
26036
+ "type": {
26037
+ "type": "array",
26038
+ "items": "string"
26039
+ },
26040
+ "name": "values",
26041
+ "default": [],
26042
+ "doc": "Values. one of which the intended field should match\nNote, if values is set, the above \"value\" field will be ignored"
26043
+ },
26044
+ {
26045
+ "type": "com.linkedin.pegasus2avro.metadata.query.filter.Condition",
26046
+ "name": "condition",
26047
+ "default": "EQUAL",
26048
+ "doc": "The condition for the criterion, e.g. EQUAL, START_WITH"
26049
+ },
26050
+ {
26051
+ "type": "boolean",
26052
+ "name": "negated",
26053
+ "default": false,
26054
+ "doc": "Whether the condition should be negated"
26055
+ }
26056
+ ],
26057
+ "doc": "A specific type of field condition that checks whether a field should be shown based on the value of a previously completed field."
26058
+ }
26059
+ ],
26060
+ "name": "singleFieldValueCondition",
26061
+ "default": null,
26062
+ "doc": "A field value condition. Present if type is FIELD_VALUE."
26063
+ }
26064
+ ],
26065
+ "doc": "A condition that determines whether a form field should be shown in the action workflow.\nThis may evolve in the future to have additional condition types."
26066
+ }
26067
+ ],
26068
+ "name": "condition",
26069
+ "default": null,
26070
+ "doc": "A dynamic condition that determines whether the field should be shown or not."
26071
+ }
26072
+ ],
26073
+ "doc": "A field inside an Action Workflow Form."
26074
+ }
26075
+ },
26076
+ "name": "fields",
26077
+ "doc": "Fields comprising the workflow request. These are the inputs / arguments required to trigger the workflow."
26078
+ }
26079
+ ]
26080
+ }
26081
+ ],
26082
+ "name": "form",
26083
+ "default": null,
26084
+ "doc": "The form definition that will trigger the action workflow when submitted. "
26085
+ }
26086
+ ],
26087
+ "doc": "Defines the conditions on which the action workflow is triggered. \n\nCurrently we have only one trigger type, but we expect this to extend e.g. in the case that change events, proposals,\nor other actions can trigger workflows. \n\nCurrently, the workflow must have exactly 1 trigger condition. We don't expect this to change. "
26088
+ },
26089
+ "name": "trigger",
26090
+ "doc": "The action or event that triggers the workflow. This MUST be stored here, because there is no other\nplace to capture dynamic form state like this. "
26091
+ },
26092
+ {
26093
+ "type": {
26094
+ "type": "array",
26095
+ "items": {
26096
+ "type": "record",
26097
+ "name": "ActionWorkflowStep",
26098
+ "namespace": "com.linkedin.pegasus2avro.actionworkflow",
26099
+ "fields": [
26100
+ {
26101
+ "type": "string",
26102
+ "name": "id",
26103
+ "doc": "A unique identifier for this step within the workflow.\nThis ID must be unique within the workflow and is used to match values during workflow execution."
26104
+ },
26105
+ {
26106
+ "type": {
26107
+ "type": "enum",
26108
+ "symbolDocs": {
26109
+ "APPROVAL": "The only step type currently supported - a human review step. \nThis step type requires that an assigned user reviews an action request associated with this workflow. \nreviews the request, approving or denying it (currently the actions supported, may extend later). "
26110
+ },
26111
+ "name": "ActionWorkflowStepType",
26112
+ "namespace": "com.linkedin.pegasus2avro.actionworkflow",
26113
+ "symbols": [
26114
+ "APPROVAL"
26115
+ ]
26116
+ },
26117
+ "name": "type",
26118
+ "doc": "A type of step / task / node in the Action Workflow. "
26119
+ },
26120
+ {
26121
+ "type": [
26122
+ "null",
26123
+ "string"
26124
+ ],
26125
+ "name": "description",
26126
+ "default": null,
26127
+ "doc": "Optional description shown alongside the step to explain its purpose."
26128
+ },
26129
+ {
26130
+ "type": [
26131
+ "null",
26132
+ {
26133
+ "type": "record",
26134
+ "name": "ActionWorkflowStepActors",
26135
+ "namespace": "com.linkedin.pegasus2avro.actionworkflow",
26136
+ "fields": [
26137
+ {
26138
+ "Urn": "Urn",
26139
+ "urn_is_array": true,
26140
+ "type": {
26141
+ "type": "array",
26142
+ "items": "string"
26143
+ },
26144
+ "name": "users",
26145
+ "doc": "Users statically assigned to perform the review step."
26146
+ },
26147
+ {
26148
+ "Urn": "Urn",
26149
+ "urn_is_array": true,
26150
+ "type": {
26151
+ "type": "array",
26152
+ "items": "string"
26153
+ },
26154
+ "name": "groups",
26155
+ "doc": "Groups statically assigned to perform the review step."
26156
+ },
26157
+ {
26158
+ "Urn": "Urn",
26159
+ "urn_is_array": true,
26160
+ "type": {
26161
+ "type": "array",
26162
+ "items": "string"
26163
+ },
26164
+ "name": "roles",
26165
+ "doc": "Roles statically assigned to perform the review step."
26166
+ },
26167
+ {
26168
+ "type": [
26169
+ "null",
26170
+ {
26171
+ "type": "record",
26172
+ "name": "ActionWorkflowStepDynamicAssignment",
26173
+ "namespace": "com.linkedin.pegasus2avro.actionworkflow",
26174
+ "fields": [
26175
+ {
26176
+ "type": {
26177
+ "type": "enum",
26178
+ "symbolDocs": {
26179
+ "ENTITY_DATA_PRODUCT_OWNERS": "Assign the entity data product owners.",
26180
+ "ENTITY_DOMAIN_OWNERS": "Assign the entity domain owners.",
26181
+ "ENTITY_OWNERS": "Assign the entity owners."
26182
+ },
26183
+ "name": "ActionWorkflowStepDynamicAssignmentType",
26184
+ "namespace": "com.linkedin.pegasus2avro.actionworkflow",
26185
+ "symbols": [
26186
+ "ENTITY_OWNERS",
26187
+ "ENTITY_DOMAIN_OWNERS",
26188
+ "ENTITY_DATA_PRODUCT_OWNERS"
26189
+ ]
26190
+ },
26191
+ "name": "type",
26192
+ "doc": "A standardized policy for resolving actors dynamically for an access request."
26193
+ },
26194
+ {
26195
+ "Urn": "Urn",
26196
+ "urn_is_array": true,
26197
+ "type": [
26198
+ "null",
26199
+ {
26200
+ "type": "array",
26201
+ "items": "string"
26202
+ }
26203
+ ],
26204
+ "name": "ownershipTypeUrns",
26205
+ "default": null,
26206
+ "doc": "Optional: A well defined set of ownership type urns to including in routing."
26207
+ }
26208
+ ]
26209
+ }
26210
+ ],
26211
+ "name": "dynamicAssignment",
26212
+ "default": null,
26213
+ "doc": "Dynamic assignment type for the review step."
26214
+ }
26215
+ ],
26216
+ "doc": "A definition of the actors required to review."
26217
+ }
26218
+ ],
26219
+ "name": "actors",
26220
+ "default": null,
26221
+ "doc": "A definition of the actors required to execute the step, if there are any.\n\nFor steps of type REQUEST_REVIEW, this field MUST be provided! "
26222
+ }
26223
+ ],
26224
+ "doc": "Defines a single review step in a workflow.\n\nToday, steps are simple. They execute in sequence after the trigger event. \n\nIn the future, we may extend steps to include \"depends on steps\" to form a DAG structure across\nsteps. For now, steps execute in linear sequence after the trigger event -- however the expectation\nis that they COULD run in parallel after the trigger event without a problem in the future.\n\nIf necessary, we'll extend this to represent conditional branching nodes as a step / node in the Workflow, e.g. Conditional Step, Notification Step, Review Step\n\nToday, step state is reflected via a single entity representing the workflow instance: the ActionRequest entity.\nIn the future we'll explore modeling individual step states separately if required."
26225
+ }
26226
+ },
26227
+ "name": "steps",
26228
+ "doc": "Definition of the steps / tasks / nodes comprising the workflow definition. This is the part we can aim \nto be able to convert / transform into serialized XML BPMN Format. For now, we model it strongly here. \nIf we can successfully use BPMN for step state, we can deprecate this field in place of the XML serialization. \n\nThis is the part we'll try to build a transpiler to BPMN for execution for. Ultimately, we do need \na representation we can easily convert into the frontend framework for display. This represents the set of \nwell known workflow step types - across tasks, conditionals, notifications, etc - that are officially supported today.\n\nIf necessary, we'll extend this to represent conditional branching nodes as a step / node in the Workflow, e.g. Conditional Step, Notification Step, Review Step"
26229
+ },
26230
+ {
26231
+ "Searchable": {
26232
+ "/actor": {
26233
+ "fieldName": "createdBy",
26234
+ "fieldType": "URN"
26235
+ },
26236
+ "/time": {
26237
+ "fieldName": "createdAt",
26238
+ "fieldType": "DATETIME"
26239
+ }
26240
+ },
26241
+ "type": "com.linkedin.pegasus2avro.common.AuditStamp",
26242
+ "name": "created",
26243
+ "doc": "Audit stamp capturing the time and actor who created the workflow."
26244
+ },
26245
+ {
26246
+ "Searchable": {
26247
+ "/time": {
26248
+ "fieldName": "lastModifiedAt",
26249
+ "fieldType": "DATETIME"
26250
+ }
26251
+ },
26252
+ "type": "com.linkedin.pegasus2avro.common.AuditStamp",
26253
+ "name": "lastModified",
26254
+ "doc": "Audit stamp capturing the time and actor who last modified the workflow."
26255
+ }
26256
+ ],
26257
+ "doc": "The ActionWorkflowInfo record captures the metadata and configuration of a workflow.\nTODO: In the future, we may store the serialized camunda / flowable workflow instance ID inside.\nWe'll likely also need to add the \"steps\" into here since we'll need that to inform state transitions."
26258
+ },
25596
26259
  {
25597
26260
  "type": "record",
25598
26261
  "Aspect": {
@@ -28685,29 +29348,7 @@
28685
29348
  "null",
28686
29349
  {
28687
29350
  "type": "array",
28688
- "items": {
28689
- "type": "record",
28690
- "name": "PropertyValue",
28691
- "namespace": "com.linkedin.pegasus2avro.structured",
28692
- "fields": [
28693
- {
28694
- "type": [
28695
- "string",
28696
- "double"
28697
- ],
28698
- "name": "value"
28699
- },
28700
- {
28701
- "type": [
28702
- "null",
28703
- "string"
28704
- ],
28705
- "name": "description",
28706
- "default": null,
28707
- "doc": "Optional description of the property value"
28708
- }
28709
- ]
28710
- }
29351
+ "items": "com.linkedin.pegasus2avro.structured.PropertyValue"
28711
29352
  }
28712
29353
  ],
28713
29354
  "name": "allowedValues",
@@ -28716,15 +29357,7 @@
28716
29357
  },
28717
29358
  {
28718
29359
  "type": [
28719
- {
28720
- "type": "enum",
28721
- "name": "PropertyCardinality",
28722
- "namespace": "com.linkedin.pegasus2avro.structured",
28723
- "symbols": [
28724
- "SINGLE",
28725
- "MULTIPLE"
28726
- ]
28727
- },
29360
+ "com.linkedin.pegasus2avro.structured.PropertyCardinality",
28728
29361
  "null"
28729
29362
  ],
28730
29363
  "name": "cardinality",