[dashboards as code] small dashboard API cleanups (#244252)

Small dashboard API clean
* removes `version` key from dashboard state. It was never used
* read only returns references when references array has values.

---------

Co-authored-by: kibanamachine <[email protected]>
Co-authored-by: Elastic Machine <[email protected]>

Author: 3 people

src/platform/plugins/shared/dashboard/server/api/dashboard_state_schemas.ts

@@ -175,6 +175,5 @@ export function getDashboardStateSchema() {
     ),
     timeRange: schema.maybe(timeRangeSchema),
     title: schema.string({ meta: { description: 'A human-readable title for the dashboard' } }),
-    version: schema.maybe(schema.number({ meta: { deprecated: true } })),
   });
 }

src/platform/plugins/shared/dashboard/server/api/saved_object_utils.ts

@@ -56,7 +56,7 @@ export function getDashboardCRUResponseBody(
     id: savedObject.id,
     data: {
       ...dashboardState,
-      references,
+      ...(references.length && { references }),
     },
     meta: getDashboardMeta(savedObject, operation),
     spaces: savedObject.namespaces,

src/platform/plugins/shared/dashboard/server/api/transforms/out/transform_dashboard_out.ts

@@ -32,8 +32,8 @@ export function transformDashboardOut(
     timeRestore,
     timeTo,
     title,
-    version,
   } = attributes;
+
   // Extract tag references
   const tags: string[] = references
     ? references.filter(({ type }) => type === tagSavedObjectTypeName).map(({ id }) => id)
@@ -64,6 +64,5 @@ export function transformDashboardOut(
     ...(tags && tags.length && { tags }),
     ...(timeRange && { timeRange }),
     title: title ?? '',
-    ...(version && { version }),
   };
 }

src/platform/test/api_integration/apis/dashboards/create_dashboard/main.ts

@@ -31,7 +31,6 @@ export default function ({ getService }: FtrProviderContext) {
       expect(response.status).to.be(200);
       expect(response.body.spaces).to.eql(['default']);
       expect(response.body.data).to.eql({
-        references: [],
         title,
       });
     });