Hi GoodData team. I have a product improvement request. For GoodData UI plugins, I know the data shape for adding a plugin to a workspace is:

{
  "data": {
    "attributes": {
      "areRelationsValid": true,
      "content": {
        "url": "url-to-hosted-plugin",
        "version": "2"
      },
      "description": "some description",
      "tags": [
        "string"
      ],
      "title": "plugin-title"
    },
    "id": "plugin_id",
    "type": "dashboardPlugin"
  }
}

However, neither the GoodData OpenAPI spec nor the Python SDK types include the

version

property for the

attributes.content

object, i.e. you have to know that the content needs both a

url

and the

version

to be valid. I think the OpenAPI spec/Python SDK/GoodData UI documentation should be updated to reflect this and help us avoid accidentally setting customer dashboards as unavailable - the dashboards won’t load if a workspace plugin reference omits the content

version

property, which I learned today but thankfully was able to quickly rectify.

🎉 New note created.

Hi Eoghan, thank you for your product improvement request. I have gone ahead and marked this thread as “Product feedback” and this will now be visible to our Product team. Once again, we appreciate your feedback and will consider updating the OpenAPI spec, Python SDK, and GoodData UI documentation to reflect the requirement for the

version

property in the

attributes.content

object when adding a plugin to a workspace.

Cheers Michael!