Copy saved object in Spaces API not returning response according to documentation

[emilygray0702]

Kibana version: 7.8

Elasticsearch version: 7.8

Server OS version: CentOS 7 (Docker container)

Original install method (e.g. download page, yum, from source, etc.): official Elastic Docker images

Describe the bug: I used /api/spaces/_copy_saved_objects to copy a dashboard from the default space to another space. It returned with successCount 4 (I was only copying one dashboard, but possibly there were references copied as well), but no successResults array. It says in the documentation that information about the object(s) copied should be returned there. The dashboard was copied successfully.

Steps to reproduce:

1. Create dashboard in default space and create other space.
2. Execute

curl -X POST http://<your IP>/api/spaces/_copy_saved_objects -H 'Content-Type: application/json' -H 'kbn-xsrf: true' -d '{
  "objects": [
      {
        "type":"dashboard",
        "id":"<dashboard ID>"
      } 
  ],
  "spaces": [
      "<space ID>"
  ],
  "includeReferences":true,
  "overwrite":true
}'

Expected behavior:
successResults in response body

Response body:
{"<space ID>":{"success":true,"successCount":4}}

[elasticmachine]

Pinging @elastic/kibana-platform (Team:Platform)

[elasticmachine]

Pinging @elastic/kibana-security (Team:Security)

[pmuellr]

Looking at the code, it does appear that the successResults is no longer returned - not sure if this is a doc error, or if the code should be returning this, but isn't anymore.

doc: https://github.com/elastic/kibana/blob/master/docs/api/spaces-management/copy_saved_objects.asciidoc

code:

kibana/x-pack/plugins/spaces/server/routes/api/external/copy_to_space.ts

Lines 94 to 100 in 9079aca

	const copyResponse = await copySavedObjectsToSpaces(sourceSpaceId, destinationSpaceIds, {
	objects,
	includeReferences,
	overwrite,
	createNewCopies,
	});
	return response.ok({ body: copyResponse });

kibana/x-pack/plugins/spaces/server/lib/copy_to_spaces/copy_to_spaces.ts

Lines 73 to 95 in 9079aca

	const copySavedObjectsToSpaces = async (
	sourceSpaceId: string,
	destinationSpaceIds: string[],
	options: CopyOptions
	): Promise<CopyResponse> => {
	const response: CopyResponse = {};
	const exportedSavedObjects = await exportRequestedObjects(sourceSpaceId, options);
	const ineligibleTypes = getIneligibleTypes(getTypeRegistry());
	const filteredObjects = exportedSavedObjects.filter(
	({ type }) => !ineligibleTypes.includes(type)
	);
	for (const spaceId of destinationSpaceIds) {
	response[spaceId] = await importObjectsToSpace(
	spaceId,
	createReadableStreamFromArray(filteredObjects),
	options
	);
	}
	return response;
	};

[legrego]

Hi @emilygray0702,

The successResults array that you're looking for is not available in version 7.8. The docs for 7.8 don't make reference to this: https://www.elastic.co/guide/en/kibana/7.8/spaces-api-copy-saved-objects.html

successResults was introduced via #75444, which is scheduled to be released with version 7.10