@salesforce/lds-adapters-analytics-wave 1.462.0 → 1.463.0

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.
package/src/raml/api.raml CHANGED
@@ -2941,6 +2941,34 @@ types:
2941
2941
  description: An opaque, per-check payload passed through verbatim.
2942
2942
  type: string | nil
2943
2943
  required: false
2944
+ PlatformAuditReportRepresentation: # TODO Hand-rolled W-24362345
2945
+ description: Same shape as AssetReferenceRepresentation, returned by the PDF-report
2946
+ POST endpoint. Kept as a separate, keyed type (duplicated rather than extended,
2947
+ since Luvio forbids an inherited shape from declaring its own (luvio.key))
2948
+ because Luvio requires a POST adapter's return shape to define a (luvio.key),
2949
+ and giving AssetReferenceRepresentation itself a type-level key would mis-key
2950
+ its many other nested usages across this spec.
2951
+ type: object
2952
+ properties:
2953
+ id:
2954
+ description: The 18 character ID of the asset.
2955
+ type: string
2956
+ label:
2957
+ description: The asset label.
2958
+ type: string
2959
+ required: false
2960
+ name:
2961
+ description: The asset developer name.
2962
+ type: string
2963
+ required: false
2964
+ namespace:
2965
+ description: The namespace that qualifies the asset name
2966
+ type: string
2967
+ required: false
2968
+ url:
2969
+ description: The asset URL.
2970
+ type: string
2971
+ required: false
2944
2972
  PlatformAuditCheckCollectionRepresentation: # TODO Hand-rolled W-24314623
2945
2973
  description: A collection of platform audit checks.
2946
2974
  type: object
@@ -3075,6 +3103,47 @@ types:
3075
3103
  key:
3076
3104
  description: The key of the select option.
3077
3105
  type: string
3106
+ RecipeActionPermissionsRepresentation:
3107
+ description: The running user's per-action availability on a recipe, one boolean
3108
+ per recipe action. Each flag matches what the backend would enforce for that action.
3109
+ type: object
3110
+ properties:
3111
+ canDelete:
3112
+ description: Whether the user can delete the recipe.
3113
+ type: boolean
3114
+ required: false
3115
+ canDownload:
3116
+ description: Whether the user can download the recipe.
3117
+ type: boolean
3118
+ required: false
3119
+ canEdit:
3120
+ description: Whether the user can edit the recipe.
3121
+ type: boolean
3122
+ required: false
3123
+ canRun:
3124
+ description: Whether the user can run the recipe now.
3125
+ type: boolean
3126
+ required: false
3127
+ canSchedule:
3128
+ description: Whether the user can schedule future runs of the recipe.
3129
+ type: boolean
3130
+ required: false
3131
+ canSetNotifications:
3132
+ description: Whether the user can set up notifications on the recipe.
3133
+ type: boolean
3134
+ required: false
3135
+ canUpload:
3136
+ description: Whether the user can upload / overwrite the recipe.
3137
+ type: boolean
3138
+ required: false
3139
+ canView:
3140
+ description: Whether the user can view / access the recipe's details.
3141
+ type: boolean
3142
+ required: false
3143
+ canMove:
3144
+ description: Whether the user can move the recipe from the folder it is currently associated with
3145
+ type: boolean
3146
+ required: false
3078
3147
  RecipeCollectionRepresentation:
3079
3148
  description: A collection of Data Prep recipes.
3080
3149
  type: object
@@ -3392,6 +3461,12 @@ types:
3392
3461
  discriminatorValue: recipe
3393
3462
  type: BaseWaveAssetRepresentation
3394
3463
  properties:
3464
+ actionPermissions:
3465
+ description: The running user's per-action availability on this recipe, one
3466
+ boolean per recipe action. Each flag matches what the backend would enforce
3467
+ for that action.
3468
+ type: RecipeActionPermissionsRepresentation
3469
+ required: false
3395
3470
  conversionDetails:
3396
3471
  description: The upconversion details when converting dataflow to R3
3397
3472
  type: array
@@ -7803,6 +7878,29 @@ types:
7803
7878
  checkId:
7804
7879
  type: string
7805
7880
  required: true
7881
+ /platform-audit/{auditId}/report: # TODO Hand-rolled W-24362345
7882
+ get:
7883
+ description: Resolve the audit run's already-generated PDF report and return a
7884
+ reference to the downloadable File.
7885
+ responses:
7886
+ '200':
7887
+ description: Success
7888
+ body:
7889
+ application/json:
7890
+ type: AssetReferenceRepresentation
7891
+ post:
7892
+ description: Generate or reuse the audit run's PDF report and return a reference
7893
+ to the downloadable File.
7894
+ responses:
7895
+ '200':
7896
+ description: Success
7897
+ body:
7898
+ application/json:
7899
+ type: PlatformAuditReportRepresentation
7900
+ uriParameters:
7901
+ auditId:
7902
+ type: string
7903
+ required: true
7806
7904
  /platform-audit/history: # TODO Hand-rolled W-24314623
7807
7905
  get:
7808
7906
  description: Get the org's platform-audit history, most recent first. Returns an
@@ -70,6 +70,10 @@ types:
70
70
  (luvio.ttl): 300
71
71
  PlatformAuditCollectionRepresentation: # TODO Hand-rolled W-24314623
72
72
  (luvio.ttl): 300
73
+ PlatformAuditReportRepresentation: # TODO Hand-rolled W-24362345
74
+ (luvio.ttl): 300
75
+ (luvio.key):
76
+ id: id
73
77
  RecipeCollectionRepresentation:
74
78
  (luvio.opaque): true
75
79
  (luvio.ttl): 300
@@ -371,6 +375,19 @@ types:
371
375
  get:
372
376
  (luvio.adapter):
373
377
  name: getPlatformAuditCheck
378
+ /platform-audit/{auditId}/report: # TODO Hand-rolled W-24362345
379
+ # No (luvio.key): the GET response is an AssetReferenceRepresentation, which has
380
+ # no auditId field to key on (same reasoning as getPlatformAuditCheck above), so
381
+ # this caches by request path only.
382
+ get:
383
+ (luvio.adapter):
384
+ name: getPlatformAuditReport
385
+ # POST uses the separate, keyed PlatformAuditReportRepresentation type (see
386
+ # api.raml) because Luvio requires a POST adapter's return shape to define a
387
+ # (luvio.key).
388
+ post:
389
+ (luvio.adapter):
390
+ name: generatePlatformAuditReport
374
391
  /platform-audit/history: # TODO Hand-rolled W-24314623
375
392
  get:
376
393
  (luvio.adapter):