API : List Dataverse Collection Links

[g-saracca]

I wanted to suggest a small refactor for the API response format in the List Dataverse Collection Links API endpoint.
Refactoring this would greatly benefit both the SPA and other API consumers, as the current response can be a bit tricky to work with.

Current response example:

{
  "status": "OK",
  "data": {
    "dataverses that the germn-saracca-collection dataverse has linked to": [
       "germn-saracca-collection-2"
   ],
   "dataverses that link to the germn-saracca-collection": [],
   "datasets that the germn-saracca-collection has linked to": []
  }
}

I'm not entirely sure about the best naming conventions, I believe that using single-word, non-dynamic property names would significantly improve the usability and testing of the API.

[qqmyers]

maybe having a "source" key for the dataset name?

[pdurbin]

This is good timing because Tutasi at https://groups.google.com/g/dataverse-community/c/4UrPlTIlTjI/m/1HyZS3l_BQAJ is exploring APIs that list links.

That are asking for IDs or PIDs of the linked items.

[g-saracca]

I'm ok with any extra values you want to return instead of just the collections aliases.
But for the properties naming I would suggest something like:

{
  "status": "OK",
  "data": {
    "linkedDataverses": [
      "germn-saracca-collection-2"
    ],
    "dataversesLinkingToThis": [],
    "linkedDatasets": []
  }
}

Just a suggestion for you to get the idea.