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

package/src/raml/api.raml

@@ -1950,6 +1950,7 @@ types:
       lastAccessedDate:
         description: The time at which the asset was last accessed.
         type: string
+        required: false # TODO Hand-rolled W-24324703
       lastModifiedBy:
         description: The user who last modified the asset.
         type: WaveUserRepresentation
@@ -2776,6 +2777,279 @@ types:
         description: The value which indicates whether the user can view an asset.
         type: boolean
         required: false # TODO Hand-rolled W-8253396
+  PlatformAuditRepresentation: # TODO Hand-rolled W-24314623
+    description: A Platform Audit run and its aggregated health.
+    type: object
+    properties:
+      auditId:
+        description: The ID of the platform audit run.
+        type: string
+      runStatus:
+        description: The runtime status of the platform audit run.
+        type: string
+        enum:
+          - Running
+          - Ready
+          - CompleteWithLimitations
+          - Failed
+      scope:
+        description: The scope of assets covered by the platform audit run.
+        type: string
+        enum:
+          - AllSharedAssets
+      checksTotal:
+        description: The total number of checks fanned out for this audit run.
+        # TODO: Hand-rolled from "format: int64, type: integer" due to W-8274943
+        format: double
+        type: number
+      checksTerminal:
+        description: The number of checks that have reached a terminal state.
+        # TODO: Hand-rolled from "format: int64, type: integer" due to W-8274943
+        format: double
+        type: number
+      createdDate:
+        description: The date the platform audit run was created.
+        type: string
+      completedDate:
+        description: The date the platform audit run completed. Null while the run is Running.
+        type: string | nil
+        required: false
+      checks:
+        description: The checks that make up this platform audit run.
+        type: PlatformAuditCheckCollectionRepresentation
+      healthScore:
+        description: The aggregated health score for the run. Null while Running, not yet
+          computed, or suppressed.
+        type: integer | nil
+        required: false
+      verdict:
+        description: The aggregated health verdict for the run. Null while Running or not
+          yet computed.
+        type: string | nil
+        required: false
+      urgency:
+        description: The aggregated health urgency triage, split into critical-now and
+          needs-attention tiers. Omitted when scoring was suppressed or the run is still
+          running.
+        type: PlatformAuditUrgencyRepresentation | nil
+        required: false
+      scoreSuppressed:
+        description: Whether the health score is suppressed for this run.
+        type: boolean | nil
+        required: false
+  PlatformAuditSnapshotRepresentation: # TODO Hand-rolled W-24314623
+    description: Same shape as PlatformAuditRepresentation, returned by the parameterless
+      "get latest" endpoint. Kept as a separate, unkeyed type because LDS wire adapters
+      cannot precompute a normalized cache key for a GET with no URL params, which a
+      type-level (luvio.key) on the response shape requires.
+    type: object
+    properties:
+      auditId:
+        description: The ID of the platform audit run.
+        type: string
+      runStatus:
+        description: The runtime status of the platform audit run.
+        type: string
+        enum:
+          - Running
+          - Ready
+          - CompleteWithLimitations
+          - Failed
+      scope:
+        description: The scope of assets covered by the platform audit run.
+        type: string
+        enum:
+          - AllSharedAssets
+      checksTotal:
+        description: The total number of checks fanned out for this audit run.
+        # TODO: Hand-rolled from "format: int64, type: integer" due to W-8274943
+        format: double
+        type: number
+      checksTerminal:
+        description: The number of checks that have reached a terminal state.
+        # TODO: Hand-rolled from "format: int64, type: integer" due to W-8274943
+        format: double
+        type: number
+      createdDate:
+        description: The date the platform audit run was created.
+        type: string
+      completedDate:
+        description: The date the platform audit run completed. Null while the run is Running.
+        type: string | nil
+        required: false
+      checks:
+        description: The checks that make up this platform audit run.
+        type: PlatformAuditCheckCollectionRepresentation
+      healthScore:
+        description: The aggregated health score for the run. Null while Running, not yet
+          computed, or suppressed.
+        type: integer | nil
+        required: false
+      verdict:
+        description: The aggregated health verdict for the run. Null while Running or not
+          yet computed.
+        type: string | nil
+        required: false
+      urgency:
+        description: The aggregated health urgency triage, split into critical-now and
+          needs-attention tiers. Omitted when scoring was suppressed or the run is still
+          running.
+        type: PlatformAuditUrgencyRepresentation | nil
+        required: false
+      scoreSuppressed:
+        description: Whether the health score is suppressed for this run.
+        type: boolean | nil
+        required: false
+  PlatformAuditCheckRepresentation: # TODO Hand-rolled W-24314623
+    description: A single check's result within a platform audit run.
+    type: object
+    properties:
+      checkName:
+        description: The name of the check (e.g. crma-orphans, crma-trace-redundancies).
+        type: string
+      status:
+        description: The runtime status of the check.
+        type: string
+        enum:
+          - Complete
+          - CompleteWithLimitations
+          - Unavailable
+          - Failed
+      coverageScanned:
+        description: The number of assets scanned by this check.
+        # TODO: Hand-rolled from "format: int64, type: integer" due to W-8274943
+        format: double
+        type: number
+      coverageTotal:
+        description: The total number of assets in scope for this check.
+        # TODO: Hand-rolled from "format: int64, type: integer" due to W-8274943
+        format: double
+        type: number
+      limitationNote:
+        description: A note describing why coverage was limited. Null unless limited.
+        type: string | nil
+        required: false
+      checkStartedDate:
+        description: The date this check started.
+        type: string | nil
+        required: false
+      checkCompletedDate:
+        description: The date this check completed.
+        type: string | nil
+        required: false
+      resultJson:
+        description: An opaque, per-check payload passed through verbatim.
+        type: string | nil
+        required: false
+  PlatformAuditCheckCollectionRepresentation: # TODO Hand-rolled W-24314623
+    description: A collection of platform audit checks.
+    type: object
+    properties:
+      checks:
+        description: The checks in this collection.
+        type: array
+        items:
+          type: PlatformAuditCheckRepresentation
+      totalSize:
+        description: The total number of checks in this collection.
+        type: integer
+  PlatformAuditFindingRepresentation: # TODO Hand-rolled W-24314623
+    description: One finding surfaced by the aggregator's urgency triage, referencing the
+      asset and check it came from.
+    type: object
+    properties:
+      kind:
+        description: The finding's category (e.g. zombie, unused, stale, or redundant asset).
+        type: string
+      checkName:
+        description: The stable name of the check that surfaced this finding.
+        type: string
+      refId:
+        description: The stable id of the asset the finding points at.
+        type: string
+      displayName:
+        description: The asset's display name, for rendering the finding.
+        type: string
+  PlatformAuditUrgencyRepresentation: # TODO Hand-rolled W-24314623
+    description: The aggregator's two-tier urgency triage over the run's findings.
+    type: object
+    properties:
+      criticalNow:
+        description: Findings the user should act on now, ordered as the aggregator surfaced
+          them.
+        type: array
+        items:
+          type: PlatformAuditFindingRepresentation
+      needsAttention:
+        description: Findings that need attention as standing hygiene, ordered as the
+          aggregator surfaced them.
+        type: array
+        items:
+          type: PlatformAuditFindingRepresentation
+  PlatformAuditSummaryRepresentation: # TODO Hand-rolled W-24314623
+    description: A summarized platform audit run for the history list, without per-check
+      detail or urgency.
+    type: object
+    properties:
+      auditId:
+        description: The ID of the platform audit run.
+        type: string
+      runStatus:
+        description: The runtime status of the platform audit run.
+        type: string
+        enum:
+          - Running
+          - Ready
+          - CompleteWithLimitations
+          - Failed
+      scope:
+        description: The scope of assets covered by the platform audit run.
+        type: string
+        enum:
+          - AllSharedAssets
+      checksTotal:
+        description: The total number of checks fanned out for this audit run.
+        # TODO: Hand-rolled from "format: int64, type: integer" due to W-8274943
+        format: double
+        type: number
+      checksTerminal:
+        description: The number of checks that have reached a terminal state.
+        # TODO: Hand-rolled from "format: int64, type: integer" due to W-8274943
+        format: double
+        type: number
+      createdDate:
+        description: The date the platform audit run was created.
+        type: string
+      completedDate:
+        description: The date the platform audit run completed. Null while the run is Running.
+        type: string | nil
+        required: false
+      healthScore:
+        description: The aggregated health score for the run. Null while Running, not yet
+          computed, or suppressed.
+        type: integer | nil
+        required: false
+      verdict:
+        description: The aggregated health verdict for the run. Null while Running or not
+          yet computed.
+        type: string | nil
+        required: false
+      scoreSuppressed:
+        description: Whether the health score is suppressed for this run.
+        type: boolean | nil
+        required: false
+  PlatformAuditCollectionRepresentation: # TODO Hand-rolled W-24314623
+    description: The org's platform-audit history, most recent first.
+    type: object
+    properties:
+      audits:
+        description: The org's audit runs, most recent first.
+        type: array
+        items:
+          type: PlatformAuditSummaryRepresentation
+      totalSize:
+        description: The number of audit runs returned.
+        type: integer
   PropertyConditionRepresentation:
     description: A Condition represents a condition under which a connection property will appear in the UI.
     type: object
@@ -7483,6 +7757,64 @@ types:
               - MaxDailySizeMedOutputCon
               - OutputLocalConnectorVolume
             (oas-collectionFormat): csv
+  /platform-audit: # TODO Hand-rolled W-24314623
+    get:
+      description: Get the org's latest platform audit run.
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: PlatformAuditSnapshotRepresentation
+    post:
+      description: Trigger a new platform audit run.
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: PlatformAuditRepresentation
+  /platform-audit/{auditId}: # TODO Hand-rolled W-24314623
+    get:
+      description: Get a specific platform audit run.
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: PlatformAuditRepresentation
+    uriParameters:
+      auditId:
+        type: string
+        required: true
+  /platform-audit/{auditId}/checks/{checkId}: # TODO Hand-rolled W-24314623
+    get:
+      description: Get a single check's result within a platform audit run.
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: PlatformAuditCheckRepresentation
+    uriParameters:
+      auditId:
+        type: string
+        required: true
+      checkId:
+        type: string
+        required: true
+  /platform-audit/history: # TODO Hand-rolled W-24314623
+    get:
+      description: Get the org's platform-audit history, most recent first. Returns an
+        empty collection (not a 404) when no runs exist. The connect resource hardcodes
+        offset=0/limit=200 server-side and ignores client-supplied paging params;
+        see W-24314623 comments before adding offset/limit here.
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: PlatformAuditCollectionRepresentation
   /unsupportedFeatures:
     get:
       description: Retrieves a list of unsupported features for the current environment.

package/src/raml/luvio.raml

@@ -47,6 +47,29 @@ types:
     (luvio.ttl): 300
   DatasetCoverageRepresentation:
     (luvio.ttl): 300
+  PlatformAuditRepresentation: # TODO Hand-rolled W-24314623
+    (luvio.ttl): 5000
+    (luvio.key):
+      id: auditId
+  PlatformAuditSnapshotRepresentation: # TODO Hand-rolled W-24314623
+    (luvio.ttl): 5000
+  # No (luvio.key): getPlatformAuditCheck's URI carries auditId/checkId, but a
+  # resource-level key only takes effect if the return type ALSO defines a
+  # type-level (luvio.key) (see @luvio/compiler's key-builder.js), and this
+  # type's response body has no auditId/checkId field to key on. So this caches
+  # by request path only.
+  PlatformAuditCheckRepresentation: # TODO Hand-rolled W-24314623
+    (luvio.ttl): 300
+  PlatformAuditCheckCollectionRepresentation: # TODO Hand-rolled W-24314623
+    (luvio.ttl): 300
+  PlatformAuditFindingRepresentation: # TODO Hand-rolled W-24314623
+    (luvio.ttl): 300
+  PlatformAuditUrgencyRepresentation: # TODO Hand-rolled W-24314623
+    (luvio.ttl): 300
+  PlatformAuditSummaryRepresentation: # TODO Hand-rolled W-24314623
+    (luvio.ttl): 300
+  PlatformAuditCollectionRepresentation: # TODO Hand-rolled W-24314623
+    (luvio.ttl): 300
   RecipeCollectionRepresentation:
     (luvio.opaque): true
     (luvio.ttl): 300
@@ -331,6 +354,27 @@ types:
     get:
       (luvio.adapter):
         name: getAnalyticsLimits
+  /platform-audit: # TODO Hand-rolled W-24314623
+    get:
+      (luvio.adapter):
+        name: getLatestPlatformAudit
+    post:
+      (luvio.adapter):
+        name: triggerPlatformAudit
+  /platform-audit/{auditId}: # TODO Hand-rolled W-24314623
+    get:
+      (luvio.adapter):
+        name: getPlatformAudit
+      (luvio.key):
+        id: urlParams.auditId
+  /platform-audit/{auditId}/checks/{checkId}: # TODO Hand-rolled W-24314623
+    get:
+      (luvio.adapter):
+        name: getPlatformAuditCheck
+  /platform-audit/history: # TODO Hand-rolled W-24314623
+    get:
+      (luvio.adapter):
+        name: getPlatformAuditHistory
   /unsupportedFeatures:
     get:
       (luvio.adapter):